updated Readme.md
parent
0da6cdc224
commit
d696cda80b
77
README.MD
77
README.MD
|
|
@ -1,75 +1,40 @@
|
||||||
# CrossTalk PM
|
# Oregon Trail rDrama Edition
|
||||||
|
|
||||||
CrossTalk PM serves as a digital intermediary, facilitating connections and communications between users from distinct online platforms. It primarily focuses on identifying mentions of Reddit usernames in external platforms like rDrama and subsequently, notifying the mentioned Reddit users. This endeavor aims to foster a seamless information exchange and enhance inter-community interactions.
|
Embark on the iconic journey of the Oregon Trail, reimagined for the rDrama community. This interactive text-based adventure blends the classic elements of the Oregon Trail game with modern social interactions, allowing players to navigate the perilous journey to Oregon with the decisions made directly on rDrama posts.
|
||||||
|
|
||||||
## Key Features
|
## Features
|
||||||
|
|
||||||
- **User Mention Monitoring:** CrossTalk PM diligently scans specified platforms for Reddit usernames being mentioned, ensuring no significant mention goes unnoticed.
|
- **Interactive Gameplay:** Make decisions through rDrama comments, from buying supplies to choosing your path.
|
||||||
- **Automated User Notifications:** Upon detecting a mention, it autonomously initiates a Reddit chatroom or dispatches a private message to the mentioned user, thereby alerting them.
|
- **Dynamic Events:** Face challenges and make crucial decisions that affect your health, resources, and the fate of your party.
|
||||||
- **Adherence to Privacy:** The application is designed with a strong commitment to privacy, processing only publicly disclosed information and adhering to privacy norms.
|
- **Community Engagement:** Share your journey with the rDrama community, seek advice, and interact with fellow travelers.
|
||||||
|
- **Realistic Simulation:** Deal with diseases, food shortages, bandit attacks, and the harsh realities of the trail in a quest for survival.
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
Below you'll find everything you need to know to get CrossTalk PM up and running.
|
To begin your adventure on the Oregon Trail, follow these simple steps:
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
Ensure you have the following installed:
|
- An active rDrama account.
|
||||||
- Node.js (version 14 or later is recommended for optimal compatibility)
|
- Basic understanding of Markdown formatting for posting comments.
|
||||||
- Redis server (for caching and message queuing functionalities)
|
|
||||||
- Drama Harvester https://fsdfsd.net/J/DramaHarvester
|
|
||||||
|
|
||||||
### Installation Steps
|
### How to Play
|
||||||
|
|
||||||
1. **Clone the Project:**
|
1. Start your journey by replying to any post or even on your wall with `!!Oregon Start`.
|
||||||
```bash
|
2. Make decisions by replying to game updates with commands like `!!Oregon Buy Supplies` or `!!Oregon Continue`.
|
||||||
git clone https://fsdfsd.net/J/CrossTalkPM.git
|
3. Monitor your progress, supplies, and party's health through game updates.
|
||||||
```
|
|
||||||
2. **Navigate to the Project Directory:**
|
|
||||||
```bash
|
|
||||||
cd CrossTalkPM
|
|
||||||
```
|
|
||||||
3. **Install Dependencies:**
|
|
||||||
```bash
|
|
||||||
npm install
|
|
||||||
```
|
|
||||||
4. **Set Up Environment Variables:** Create a `.env` file in the root of your project directory and populate it with the necessary configuration as shown below:
|
|
||||||
```env
|
|
||||||
REDIS_HOST=127.0.0.1
|
|
||||||
REDIS_PORT=6379
|
|
||||||
# REDIS_PASSWORD=optional (uncomment if applicable)
|
|
||||||
RDRAMA_API_KEY=your_rdrama_api_key_here
|
|
||||||
redditClientId=your_reddit_client_id
|
|
||||||
redditSecret=your_reddit_secret
|
|
||||||
redditUsername=your_reddit_username
|
|
||||||
redditPassword=your_reddit_password
|
|
||||||
EXCLUDE_EMPLOYEES=True
|
|
||||||
EXCLUDE_MODS=True
|
|
||||||
KARMA_THRESHOLD=100000
|
|
||||||
NOTIFICATION_COOLDOWN_HOURS=1
|
|
||||||
```
|
|
||||||
|
|
||||||
### Running CrossTalk PM
|
|
||||||
|
|
||||||
To activate CrossTalk PM, execute the following command within the project's root directory:
|
|
||||||
```bash
|
|
||||||
npm start
|
|
||||||
```
|
|
||||||
Upon launch, CrossTalk PM will commence its operation, scanning for user mentions and facilitating notifications through Redis.
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
We highly value and appreciate contributions from our community. Whether it's through submitting bug reports, requesting new features, or contributing directly to the codebase, your involvement is encouraged.
|
We welcome contributions from the community! Whether it's suggesting new features, improving game mechanics, or reporting bugs, your input helps enhance the Oregon Trail experience for everyone.
|
||||||
|
|
||||||
### How to Contribute:
|
|
||||||
|
|
||||||
|
To contribute, please follow these steps:
|
||||||
1. Fork the repository.
|
1. Fork the repository.
|
||||||
2. Create your feature branch (`git checkout -b feature/YourFeature`).
|
2. Create your feature branch (`git checkout -b feature/AmazingFeature`).
|
||||||
3. Commit your changes (`git commit -am 'Add YourFeature'`).
|
3. Commit your changes (`git commit -am 'Add some AmazingFeature'`).
|
||||||
4. Push to the branch (`git push origin feature/YourFeature`).
|
4. Push to the branch (`git push origin feature/AmazingFeature`).
|
||||||
5. Create a new Pull Request.
|
5. Open a Pull Request.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
CrossTalk PM is made available under the MIT License.
|
This project is licensed under the MIT License
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue