Giter VIP home page Giter VIP logo

blacket's Introduction


Logo

Blacket

The first ever open-source Blooket private server created by Xotic written entirely in NodeJS.
Get Help
Report Bug Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. License

About The Project

Me personally, I love Blooket and everything about it, but I felt something was missing. A lot of people have made Blooket cheat scripts / hacks but has never ever created anything completely for Blooket itself. So thats why I created Blacket, the first open-source Blooket private server. I always wanted to have the ability to have custom packs, blooks, and more but I can't since I am not Ben Stewart (the creator of Blooket) so I have decided to create this.

(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:

  • NodeJS

    cd ~
    curl -sL https://deb.nodesource.com/setup_17.x -o /tmp/nodesource_setup.sh
    sudo bash /tmp/nodesource_setup.sh
    sudo apt install nodejs
  • 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 home folder:

    cd /temp
    git clone https://github.com/XOTlC/Blacket.git
    sudo mv -v /temp/Blacket-master ~/blacket
  2. Configure Blacket for the database:

    sudo visudo ~/blacket/config.js


    Change host to the host of the MySQL database (should be localhost by default).
    Change user to the username you configured in the MySQL setup process (should be root by default).
    Change password to the password you configured in the MySQL setup process.
    Change database to the name of the database you want to use.
    Leave multipleStatements on true.

  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)

blacket's People

Contributors

xotlc avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.