Skip to content
Kerolos Zaki edited this page Jul 13, 2023 · 87 revisions

For information related to the gameplay, please call /help

This wiki is related to Fable's source code and community packs.

We also have the #help-and-questions channel, where you can ask any questions you have.

Packs Documentation

Useful Links

Useful Documentations

Getting Involved

If you're interested in joining the community and helping us make a better Fable, there are two ways to go:

Contributing with Code

Open in GitHub Codespaces

Getting Setup

You will need all Nodejs, Deno installed.

Fork this repo

Clicking the fork button on the top right will clone the repository to your own account. From there you can clone it to your machine.

Don't know what we are talking about or have never worked with git repos before? check the first-contributions guide.

Clone the fork to your local machine

And also don't forget also to fetch the git submodules

Setup environment

Run and follow the script instructions

deno run -A setup.ts

Stack

  • Deno (Runtime)
  • Fauna (Database)
  • Ngrok (Local Development)
  • Deno Deploy (Production)

We don't use libraries like discord.js or any other

We use Discord Interactions Endpoints (meaning we don't connect to discord using their web sockets server).

This means the code will look unfamiliar to people who are used to developing discord bots using those methods.

What's next?

You can work on your own ideas, create your own features, fix any bugs you found, or find an issue labeled Good First Issue[^1] and start contributing to the code.

Push any changes you make to your fork of Fable. And when you're done, you need to open a "Pull Request" in our original repository.

Pull Requests

When opening a pull request, describe any changes you made as detailed as you have the patience to do. And any thoughts you have about those changes. And if those changes introduce new code, please try your best to write tests for it, no pull requests will be merged if it's not tested well, by testing your code, it will be merged faster.

Github should automatically run tests on every new commit you push on your fork.

The Fable team monitors all pull requests regularly. We'll try finishing pull requests even if they are missing things, but help us by keeping your pull requests tidy and consistent by following the guidelines above, and answering any questions left by us.

[^1]: A good first issue is a term that refers to beginner-friendly issues/features that can help new people who are unfamiliar with open-source make their first contributions.

Important

This wiki is only about Fable's source code
For information related to the gameplay, please call /help in discord

Useful Links

Clone this wiki locally