Blacket

The first ever open-source Blooket private server made entirely from PHP.
Get Help
Report Bug Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
   • Admin Panel
   • Default Values
   • Creating Boxes
   • Creating Blooks
   • Creating News
4. License

About The Project

Me personally, I love Blooket and everything about it, but I felt something is missing. A lot of people mess around with Blooket internally not in the greatest ways but has never ever created anything completely for Blooket itself. So thats why I created Blacket, the first Blooket private server that will probably be the only one. I always wanted to be able to have custom boxes, blooks, and more but I can't since I am obviously not Ben Stewart (creator of Blooket) so I decided to create this.

(back to top)

Built With

• php

(back to top)

Getting Started

Having any debian server should be good for Blacket. If you don't know where to start, I would recommend Linode for beginners.

Prerequisites

The following packages need to be installed before starting:

• nginx

  sudo apt update
  sudo apt-get install nginx

• php

  sudo apt update
  sudo apt-get install php7.4-fpm

• phpmyadmin

  sudo apt update
  sudo apt-get install phpmyadmin

• mysql

  sudo apt update
  sudo apt-get install mysql-server

  Follow the instructions for all of the packages that will show on screen.

Installation

1. Clone the repo into your /var/www/html folder:

   cd /var/www/
   git clone https://github.com/XOTlC/Blacket.git
   sudo mv -v /var/www/Blacket-master /var/www/html

2. Configure Blacket for the database:

   sudo visudo /var/www/html/worker/config/connection.php

   Leave host as localhost.
   Change user to the name of the MYSQL database, should be root by default.
   Change password to the password you configured in the MYSQL setup process.
   Change dbname to the name of the database you want to use.
   

3. Setup the database:

   • Visit the IP of the server your Blacket instance is running on, and go through the setup process.

(back to top)

Usage

Admin Panel

If you have done everything right so far, you should be able to access the homepage of your Blacket instance. To access the admin panel, login to the account you granted admin with and click the admin button in the top right corner.

Once you have clicked the button, you should meet a similar looking page:

Default Values

To change the default values such as the daily token limit, click Default Values on the admin panel.

From here, you can edit default values that are set in Blacket that will update globally.

Creating Boxes

To create a box, click the Box Editor button on the admin panel.

All boxes must follow the format shown below to work:

From here, you can edit boxes and create boxes easiely.

Creating Blooks

To create a blook, click the Blook Editor on the admin panel.

From here, you can change any blook and create blooks easiely.

Creating News

To add news to your server, click the News Editor on the admin panel.

From here, you can create news and delete news from your server.

For more examples, please refer to the Documentation

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE.txt for more information.

(back to top)