ZLevels

An open-source Discord bot, which adds a levelling system to your server.

Installing

Requirements

• Latest Version of Java.
• A MySQL database that you can connect to remotely or locally.

Installing

1. Download the larest jar file from https://github.com/ZP4RKER/ZLevels/releases.
2. Create a directory/folder anywhere on your compuer and put the jar file inside of it.
3. Create a text document in that folder and copy the following code into it.

java -jar ZLevels.jar

4. Save the text document as run.bat for Windows, or run.sh for macOS and Linux. (Make sure not to save it as run.bat.txt, and make sure to save it into the same directory/folder as the jar).

If not on macOS go straight to step 7.

5. Open Terminal.
6. Type chmod a+x , then drag the file you just created into the Terminal window, then press enter.
7. Now run the file you just created and close the console once it stops, it should have generated a file called config.yml.
8. Fill in the config.yml with all your preferred configurations. Overview of config:

basic-settings:
    name: 'Levels Bot' # The name of your bot
    token: 'This-Is-Totally-A-Real-Token' # The token of your bot user account can be found [here](https://discordapp.com/developers/applications/me) if you have not made a bot user yet, click the New App button, give it a name and avatar then click create app and then the create bot user button
    prefix: '/' # The characters put before a command. It can be whatever you want, however it cannot contain spaces yet.
    server: '234534392897339392' # Your server id goes here, you can get it by right clicking your server's icon and clicking copy id in Discord on a computer.
    ops:
    - '145064570237485056' # A list of users (by their id, get a user's id by right clicking their name and clicking copy id) that are able to use op only commands in ZLevels.
    embed-colour: '#fbae1d' # The colour of embeds. (Hex colours)
    game-status: '' # The Playing status of the bot.
database:
    host: '149.56.141.103' # The IP of the mysql server that the Database is located on (127.0.0.1 for localhost).
    port: '3306' # The port of the mysql server (3306 is the default port and shouldn't really be anything else).
    name: 'BotDB' # The database name of the bot.
    user: 'username' # Your mysql username.
    pass: 'password123' # Your mysql password.
more-settings:
    error-length: 600 # Amount of milliseconds errors show for.
    autorole-enabled: true # If rewards from roles.yml should be enabled.
staff-ratings:
    enabled: true # If Staff Ratings are enabled.
    staff-role: 'Staff' # The role which ratings listen for.
    channels: [] # Channels that ratings should be enabled in, use the channel ids (Right click channel and click copy id).

9. Run the startup file again, then once it says its generated a file called roles.yml, close the console.
10. Add in what roles you want people to get at certain levels. example: (Or leave it blank for no roles to be given).

MEMBER: # The name of the reward.
    name: Member # The name of the role to give (Case-sensitive).
    level: 5 # At what level to give the reward.
VIP:
    name: Vip
    level: 20

11. Run the startup file again.
12. ZLevels is now running, enjoy!
13. To stop ZLevels, just hit the x at the top of the window of the console.

Credits

• Madzahttr - Writing the instructions.