47 lines
3.4 KiB
Markdown
47 lines
3.4 KiB
Markdown
# idlefox
|
|
  
|
|
|
|
IdleFox is a feature-rich Discord bot designed to streamline the process of finding meeting dates, organizing events, and making decisions among multiple options. With its user-friendly commands and robust command system, IdleFox helps facilitate effective communication within server communities.
|
|
|
|
### Key Features
|
|
- **Advanced Date Handling**: IdleFox offers robust date parsing and manipulation, supporting complex date formats and context-aware conversions.
|
|
- **Find Meeting Dates**: Easily coordinate with your community through reaction-voting for dates.
|
|
- **Event Organization**: Start events to organize group activities, meetups, or campaigns.
|
|
- **Decision Making**: Use the bot's voting functionalities to make informed decisions among multiple options.
|
|
- **Vote Management**: Keep track of ongoing votes and manage their lifecycle from initiation to closure.
|
|
- **Vote Organization**: Delays vote posting and allows continuous editing of answers as time progresses.
|
|
- **Web Interface**: Provides monitoring of all activities and enables admins to close votes through a web interface.
|
|
|
|
|
|
## Bot Components
|
|
- `main.rs`: Initializes logging and starts the main loop for handling Discord interactions.
|
|
- `config.rs`: Manages configuration settings for the bot, ensuring data persistence and recovery.
|
|
- `date/`: Provides functionalities for date parsing, conversion, and manipulation.
|
|
- `dateparse.rs`: Parses input strings into date objects using nom parsers.
|
|
- `date_tools.rs`: Transforms dates into more precise formats based on context.
|
|
- `io.rs`: Interacts with Discord through Serenity and Poise libraries to handle commands and events.
|
|
- `votes.rs`: Manages event and vote data structures, enabling voting functionality within Discord servers.
|
|
- `persistence.rs`: Ensures data persistence and integrity between bot runs.
|
|
- `server.rs`: Provides server-related functionalities, such as displaying votes and closing ongoing votes.
|
|
- `modules.rs`: Aggregates various voting logic functions into a single module for easier management and use within the application. This includes decision-making features beyond simple vote counting.
|
|
- `error_handling.rs`: Handles error reporting and logging, ensuring that any issues encountered by the bot are appropriately recorded and reported.
|
|
|
|
A great emphasis is put on organizing the votes themselves, delaying posting them and editing the answers as time goes.
|
|
|
|
This bot also spins a web interface to allow real time monitoring of all activities and (for admins) close the votes via said interface
|
|
|
|
## List of commands
|
|
* `/vote_modal` Pops up a modal (discord form) helping the user through creating a vote.
|
|
* `/vote_command` Comprehensive text command for creating a vote.
|
|
* `/vote_short` Creates an exceptional (non-weekly) vote. This is used for events outside of the normal voting window and can't go above 7 days-options.
|
|
* `/vote_long` Creates a vote for a long period of time (from 8 days to 12 months). This is used for important events that must be planned extremely long in advance.
|
|
|
|
|
|
### Contributing
|
|
|
|
IdleFox welcomes contributions from the community. To contribute, fork the repository, make your changes, and submit a pull request for review.
|
|
|
|
### License
|
|
|
|
This project is licensed under the MIT License. For more information, see the LICENSE file.
|