https://github.com/offtkp/discord-plays
A discord bot where all users can play pokemon together
https://github.com/offtkp/discord-plays
discord-bot emulator pokemon pokemon-black pokemon-emerald pokemon-gold
Last synced: 12 months ago
JSON representation
A discord bot where all users can play pokemon together
- Host: GitHub
- URL: https://github.com/offtkp/discord-plays
- Owner: OFFTKP
- Archived: true
- Created: 2022-12-02T19:38:51.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-02-05T20:37:27.000Z (over 2 years ago)
- Last Synced: 2025-04-04T18:39:18.748Z (about 1 year ago)
- Topics: discord-bot, emulator, pokemon, pokemon-black, pokemon-emerald, pokemon-gold
- Language: Go
- Homepage:
- Size: 3.46 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# discord-plays
:warning: discord-plays is currently under a rewrite! If you're looking for the stable version, try the http branch :warning:
A discord bot hosting GB, GBC, GBA, NDS and 3DS emulators!
## Commands:
`/screen` shows the in-game screen with buttons
`/summary` shows a gif of the last few frames (TODO)
`/leaderboard` shows who pressed the most keys
`/poke-jail` shows who's currently banned
## Instructions:
To add this bot to your server, follow these instructions:
- Download (or compile) the latest version of SkyEmu
- Windows: https://nightly.link/skylersaleh/SkyEmu/workflows/deploy_win/dev/WindowsRelease.zip
- macOS: https://nightly.link/skylersaleh/SkyEmu/workflows/deploy_mac/dev/MacOSRelease.zip
- Linux: https://nightly.link/skylersaleh/SkyEmu/workflows/deploy_linux/dev/LinuxRelease.zip
- While in directory `DiscordBot`, run the command `go build -o DiscordBot`
- This should create an executable named `DiscordBot`, which you can run using the terminal
- On Windows, open `cmd.exe`, navigate to the directory of the executable and run it by typing `DiscordBot.exe`
- On Linux, open your terminal emulator, navigate to the directory of the executable and run it by typing `./DiscordBot`
- The first time you run the bot, it will help you create a configuration file
- Make sure you use the token, not the application id or the public key!
- Run the bot!
You should be able to use your own emulators if you follow the [SkyEmu API](https://github.com/skylersaleh/SkyEmu/blob/dev/docs/HTTP_CONTROL_SERVER.md)
## Administration
Create an `admins.json` file in `DiscordBot/` with a json string array of all user ids you want to be administrators of the bot.
Example: `["21318712398012", "19238129031092"]` will have 2 admins with those ids.
### Admin commands:
`/poke-ban ` bans a user. If no days are specified the ban is for 9999 days.
`/poke-unban ` unbans a user
Banned users can't use bot commands.
## Compatibility with emulators
Pokemon-Bot strives to provide a simple interface that can be easily hooked to various emulators if they provide the necessary APIs.
At the moment, Pokemon-Bot has been successfully connected to the following emulators:
- The GameBoy core of [Hydra](https://github.com/OFFTKP/hydra): The emulator that inspired the project.
- [SkyEmu](https://github.com/skylersaleh/SkyEmu): Provides GB(C), GBA and NDS emulation
- [Panda3DS](https://github.com/wheremyfoodat/Panda3DS): Provides 3DS emulation
## Try it out!
Here's some Discord servers where you can find this bot to try it out! The game currently being played on these servers may vary, so hop on and check out what's currently playing!
- [SkyEmu server](https://discord.com/invite/tnUEtmJgA5): Play GB/GBC/GBA/DS games, running on SkyEmu
- [Panda3DS server](https://discord.com/invite/ZYbugsEmsw): Play 3DS games, running on Panda3DS
## Ack
Thanks to Sky for [SkyEmu](https://github.com/skylersaleh/SkyEmu)
and my friends at the emudev discord.