Skip to content

Katekko/rpgland-js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

98 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pt-br

RPG Land

This project is an RPG WhatsApp bot built using the WhatsApp Web API and Firebase Firestore. It provides various commands and features to engage in role-playing adventures with the bot.


PRE-ALPHA STAGE

⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

This project is currently in pre-alpha stage, which means it is still under active development and may contain bugs or incomplete features. Please keep in mind that the project is in its early stages and is subject to changes and improvements. All text and functionality provided is part of the pre-alpha version.

Please note that this pre-alpha version of the project is still under development, and there is a possibility of data wipes or resets. Any progress or data associated with your account may be subject to deletion or modification during this phase. We recommend not relying on persistent data or important information during the pre-alpha stage.

⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️


Prerequisites

Before running the project, make sure you have the following prerequisites installed on your system:

  • Node.js
  • NPM (Node Package Manager)
  • Firebase Firestore (configured and credentials available)

Installation

1. Clone the repository:

  • Open a new terminal and execute:

    git clone <repository-url>
    

2. Install dependencies:

  • Then locate the newly created folder:

    cd rpgland
    
  • And install the dependencies:

    npm install
    

3. Configuration:

  • Set up Firebase Firestore and obtain the necessary credentials.
  • Place your Firebase credentials file named key.json in the root directory of your project..

4. Run the project:

  • In your terminal, run:

    npm start
    

Usage

Once the project is running, you can interact with the bot using WhatsApp. Add the bot's phone number to your contacts and send messages to start using the available commands.


Available Commands

TODO


A little demonstration

image image image image


Contributing

Contributions are welcome! If you find any issues or have suggestions for improvement, please open an issue or submit a pull request.


License

This project is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published