/MemeRoyale

Primary LanguageTypeScript

MemeRoyale Bot

Maintenance GitHub issues

Hi! If you are reading this, then you found my discord bot. It's called MemeRoyale. This bot is used to run a meme tournament on a server called MemeRoyale. You can join here.

Table of Contents

General

The bot is as of now actively maintained and will be done till all edge cases are worked out. Once we reach this point and no new features are being worked on, the bot will not see active maintenance on the codebase. However, this does not apply to the API which has its docs here.. Of course, you can always suggest new features and show your implementation of how you think these features can be made. In terms of technology that's used, please look at the list below:

Requirements:

  • Typescript @4.1.3

  • NodeJS @ 13.6.0

  • NodeJS MongoDB Driver @3.6.3

  • Discord.JS v12.5.1

  • Node Canvas @ 2.6.1

A more detailed version of this can be found in the package.json file. To get a list of all the dependencies and any sub-dependencies they may have please look at package-lock.json.

Files

Match card, .env file, and all non-code files

As of now, I don't have a public env example file however, this is where all the sensitive data is being stored. This includes the discord bot token and MongoDB url needed to access the database. An environment (.env) file is required to make this bot work. This is a good read on what to do and not to do.

  • [NO] example env available

The match card is used to show a Player vs Player card before their regular matches. You can use any other image just note that there are image requirements that need to be followed. I can provide the image requirements but they are also in the code. You can do trial and error if you use it.

Additionally, since this is a rewrite of another repo, one would expect the old repo's non-code files. I have decided to not copy over these code files since that old repo still has them. In addition, the old repo will not be deleted, allowing for future access to those files.

JSON Files

There are three very important JSON Files. Of which you need to have 2 of them, the package.json file and tsconfig.json file. The former provides the program with the information on all the dependencies used, and the latter is needed to have the compiled typescript code be structured needed to run said bot. The package-lock.json file is auto-generated I believe, but in any case, it is provided in the repo

Rename a file

You can rename files as you see fit, just note that you will be responsible for changing all the equivalent references of the file's name. This may lead to code breakage.

Delete a file

Unless it is a file I deleted, please do not delete any files without some thought. Of course, you are allowed to modify this program as you see fit just note, that if you do, I am not responsible for anything that happens.

Synchronization

If you wish to run this bot with any features I make, then you should on the regular push all changes from the Master branch to your code. This branch will hold all the stable features of the bot. Of course, if you want to try out new branches and their code, you are free to do so at your own risk. I will not provide any installation instructions on these branches unless stated otherwise.

Installation

For both local and hosted steps, you will need a copy of the bot. Do this by going to this link and downloading a zip copy. You can also go to the repo, and download it in another manner.

Locally

You can run this bot in two ways, locally or on the web. To run this bot locally you have to have the NodeJS Runtime on your PC and have some basic knowledge of using the command prompt/terminal. If you are using the bot as is then follow these instructions, if you are modifying the bot, then follow these instructions but I can't promise anything from working properly.

First, make sure you downloaded either the latest version of Node or the version or the one specified by this document. As long as the version is equal to or greater than the one I stated, you should be fine.

To check if you have Node running, open a command line or command prompt and run $ node -v The out should be the version number that is either equal to or greater than this.

Next, you are going to need a MongoDB server. Now I'll leave this up to you on how you acquire this as there are many ways to make one, however, some links are down below to help you.

After this step, you are going to need to create a .env file. The .env file should contain these variables, which are important for running the bot. Should look this

  • Token is your discord token
  • dbname, is the name of your database. Now this can be anything you want as MongoDB will automatically create the DB if it doesn't exist
  • dburl is the URL connection for your DB.
  • Prefix is for the bot prefix, and status is for the bot status.
  • Challonge is your challonge API key. Now you don't need this, but some features of the bot will break without it.

Now once you have all these files set up, it's time to compile the TS code. Now all you have to do to run the bot is open a terminal in the folder. For Windows users, right-click and it should say open command prompt.

Now you can use the NPM scripts or compile the TS code your way. I'd recommend using the NPM scripts, but you are free to choose.

The first command you need to run is $ npm i. What this command will do is install all the libraries needed to run this bot. Now, this step may take some time, so be patient.

Using this command: $ npm test, this will build/compile the TS code and run the bot if everything has been correctly placed.

And you are done! The bot should be working perfectly and will run as so long as you don't do Crtl+C in the terminal or close the terminal.

Every time you make a change, you can use $ npm build to build those changes. If you want to have the code rebuilt after every time you save, you can use $ npm cibuild To run this code thereafter, you can use $ npm start. $ npm test basically runs $ npm build and then $ npm start.

Cloud

To host the bot on a server, you can use services such as Heroku. As their many forms of these services, find the best one for you and use their installation guide. The steps are is the dB steps, which you will need regardless of how you host the bot. The compiled Typescript files are not included as there is an NPM script called postinstall. Using postinstall, the server you are hosting on should be able to compile your Typescript code.