Ustiuak

A feature-rich Discord currency bot inspired by the legendary Mystiuak, bringing back the classic economy bot experience with modern improvements.

📖 About

Ustiuak is a recreation of the beloved Mystiuak currency bot that shut down. This bot brings back the classic economy system with:

• 💰 Virtual currency system
• 🎰 Interactive economy games
• 📊 Leaderboards and rankings
• 🏪 Item inventory system
• ⚡ Fast and reliable performance

✨ Features

• Currency Management - Earn, spend, and trade virtual currency
• Rank System - Progress through ranks with unique multipliers
• Stack Mechanics - Build your stack to increase earnings
• Persistent Storage - MongoDB integration for reliable data storage
• Modern Discord Integration - Built with Discord.js v14

🚀 Getting Started

Prerequisites

• Node.js (v16.9.0 or higher)
• MongoDB (local or cloud instance)
• pnpm (recommended) or npm
• A Discord Bot Token from the Discord Developer Portal

Installation

1. Clone the repository

   git clone https://github.com/lunethe/Ustiuak.git
   cd Ustiuak

2. Install dependencies

   pnpm install
   # or
   npm install

3. Configure environment variables

   Create a .env file in the root directory:

   DISCORD_TOKEN=your_discord_bot_token
   MONGODB_URI=your_mongodb_connection_string

4. Build the project

   pnpm run build
   # or
   npm run build

5. Start the bot

   node dist/index.js

🛠️ Development

Project Structure

ustiuak/
├── src/              # TypeScript source files
├── dist/             # Compiled JavaScript files
├── node_modules/     # Dependencies
├── .env              # Environment variables (not tracked)
├── tsconfig.json     # TypeScript configuration
├── package.json      # Project metadata and dependencies
└── README.md         # You are here!

Scripts

• npm test - Run tests (to be implemented)
• Build manually with tsc command

Code Style

This project uses ESLint with TypeScript support. Configuration can be found in .eslintrc.json.

Key style rules:

• Tabs for indentation
• Single quotes for strings
• Semicolons required
• No console statements restricted

🎮 Usage

Once the bot is running and invited to your server, users can interact with it using slash commands or text commands (depending on implementation).

Example Commands

Command documentation coming soon!

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the project
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Original Mystiuak bot and its community
• Discord.js for the excellent library
• All contributors and users of this project

📞 Support

If you encounter any issues or have questions:

• Open an Issue

⚠️ Disclaimer

This is a fan-made recreation and is not affiliated with the original Mystiuak bot or its creators. All rights to the original concept belong to their respective owners.

---

Made with ❤️ by the Ustiuak community