An open API service indexing awesome lists of open source software.

https://github.com/emeraldblock/not-gambling-bot

A Discord gambling bot without gambling.
https://github.com/emeraldblock/not-gambling-bot

bot discord discord-bot discord-js nodejs typescript

Last synced: 2 months ago
JSON representation

A Discord gambling bot without gambling.

Awesome Lists containing this project

README

          

# Not Gambling

### **IMPORTANT:** This bot is still in early development, so it's **not yet fit for actual use.** There are likely many ways to break it!

## About

**Not Gambling** is a Discord gambling bot... without any gambling! It features ~~a wide variety of gambling games~~ (just Blackjack right now), but there's no concept of permanent currency: You start anew every time, just like a board game.

This bot is written in [TypeScript](https://www.typescriptlang.org/). It's pretty cool!

## Using

### DISCLAIMER: While these instructions are relatively generic, I am not guaranteeing that following them will not cause any damage to your computer. *Make sure you understand what you are doing!*

This bot requires [Node.js](https://nodejs.org/). I'm not sure the specific versions that work, but any 16.7+ should work fine.

Make sure you've created an [application](https://discord.com/developers/applications) in the Discord Developer Portal and have added a bot. ([Tutorial](https://discordjs.guide/preparations/setting-up-a-bot-application.html) from the Discord.js Guide)

### Running

1. Download the ZIP of this respository and unzip it somewhere.

* Alternatively, if you have [git](https://git-scm.com/), you can shallow-clone it to more easily update it in the future.

2. Download the corresponding `dist` ZIP from the current commit's build artifacts and unzip it in the project folder.

* To download, click on the check in the commit above the files, then the details of Build, then the Artifacts in the top right, then the dist download.

3. Install dependencies by running `npm install --production` in the repo folder.

4. Rename `secrets.example.json` in [`dist/config`](dist/config) to `secrets.json` and fill in your application's bot token.

Now, you can launch the bot by running `npm start` in the project folder.

### Editing

If you want to use this bot core or contribute, follow the steps in [Running](#Running), but with the following differences:

1. It's strongly recommended to use git if you are planning on making any non-minor changes, preferably with a complete clone.

2. *skip*

3. Run `npm install` instead.

4. Do the same thing, but in [`src/config`](src/config).

Now, you can launch the bot by running `npm run dev`. This uses [nodemon](https://nodemon.io/) to re-build and restart the bot whenever a change is made to the source directory [`src`](src). You can also manually build with `npm run build` and run with `npm start`.