Giter Club home page Giter Club logo

oldschoolbot's Introduction

Discord Discord

Logo Old School Bot

Old School Bot is a Discord Bot based on Old School RuneScape

For more information on the bot: https://www.oldschool.gg/oldschoolbot

Old School Bot is not affiliated with or endorsed by Jagex. Play Old School RS for free at https://oldschool.runescape.com

OldschoolJS

Old School Bot uses oldschooljs (also made by me), for most of the OSRS related features like: simulating killing monsters, simulating clues, fetching the hiscores, checking worlds, etc. It's completely open-source and free to use.

https://github.com/gc/oldschooljs

Suggestions & Bug Reports

If you'd like to make a bug report, simply create a new issue. For suggestions, please join our support server and post it in our suggestions channel.

Contributing

Anyone is free to create PR's with improvements and additions to Old School Bot.

Please lint your code with the projects' ESLint config.

Contributors are listed in this file, and given a Contributor role in the support server. If you have more questions, send me a message on discord.

Setting up the bot to run locally for contributing

To run the bot, you need the following things: Git, Yarn, NodeJS v12+, a discord bot account

  1. Clone the repository: git clone https://github.com/gc/oldschoolbot.git
  2. Install the dependencies: yarn
  3. Make a config file from the example: cp src/config.example.ts src/config.ts
  4. Edit this new config.ts file, and input your bot token.
  5. Go to https://discord.com/developers/applications and ensure your bot has Privileged Gateway Intents > Server Members Intent enabled.
  6. Run yarn build - then run yarn start. In the future, you can type only yarn start to start the bot.

If you have errors or issues, you can ask us for help in the developer channel in the discord server.

Contributors

Notes

  1. Old School Bot uses Klasa, a discord bot framework, if you have questions as to how Klasa works, or are interested in making your own Klasa bot, you can check it out here.

  2. The trivia questions/answers are not public in this repository, to prevent people from cheating. However, you can still submit some to be added. If you wish to submit some to be added, just ask me in the developer channel in our server. There are currently 260+ trivia questions.

Self Hosting

Self hosting is not supported.

oldschoolbot's People

Contributors

gc avatar dependabot-preview[bot] avatar alexsuperfly avatar devin8 avatar umdlye avatar cadyb avatar coolbop32 avatar ms813 avatar duracell33 avatar hoffi-coffi avatar jamosaur avatar tsukadev avatar vladfrangu avatar dependabot[bot] avatar ard35 avatar brettmerri avatar lajnux avatar aryvyo avatar thorru avatar geeckon avatar osrsolympus avatar ravestrike 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.