Warning

This project is no longer active as it is no longer funded and valuable.

Chaser

Despite the Rucoy Online 2D MMORPG's vibe, there are still a lot of scammers in the game, which amount we are striving to reduce. Using this application, it is simple to determine whether a user is a scammer.

☑️ Prerequisites

• .NET – The software development kit.
• MySQL – The database provider used by this project.

📦 Installation

To start using the application, open a command prompt and follow these instructions:

Step 1 — Clone the repository

Get a local copy and navigate to the cloned repository:

git clone https://github.com/zobweyt/Chaser.git
cd Chaser/Chaser

Step 2 — Configure the environment

We are using the options pattern for strongly typed access to groups of related settings. You should configure the appsettings.json file or manage user secrets via CLI:

dotnet user-secrets set <key> <value>

Key	Type	Description	Required
Links:Vote	string	The URL to vote for the bot.
Links:Github	string	The URL to the open-source GitHub code of the application.
Links:Discord	string	The URL to your Discord community server.
Startup:Token	string	The token obtained from the Discord Developer Portal.	☑
Startup:DevelopmentGuildId	ulong	The ID of your server in the Discord used for development purposes.	☑
ConnectionStrings:Default	string	The connection string of your MySQL database.	☑

Step 3 — Run the application

Pending database migrations will be applied automatically on startup:

dotnet run

Warning: Instead of using dotnet run to run application in production, create a deployment using the dotnet publish command and deploy the published output.

🧪 Testing

This project utilizes the xUnit framework for creating test cases. It also incorporates Moq for mocking objects and Bogus to generate fake data. To run all the tests, execute the following command from the root directory in your command prompt:

dotnet test

🗺️ Roadmap

To see the current and future tasks for this project, please navigate to the projects tab.

🚀 Contributing

If you would like to contribute to this project, please read the CONTRIBUTING.md file. It provides details on our code of conduct and the process for submitting pull requests.

❤️ Acknowledgments

• Discord.Net – The Discord framework used.
  • Discord.Net.Template – The application template used.
  • Discord.Addons.Hosting – Enables smooth execution of startup and background tasks.
  • Fergun.Interactive – Adds interactive functionality to commands.
• Humanizer – Utilized for manipulation and humanization of various data types.
• Microsoft.EntityFrameworkCore – A modern object-database mapper.
  • Pomelo.EntityFrameworkCore.MySql – MySQL provider for Entity Framework Core.
• discord-md-badge – Provides badge to display the bot status.

See also the list of contributors who participated in this project.

📜 License

This project is licensed under the GNU General Public License v3.0 – see the LICENSE.md file for details.