Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Jumitti committed Jun 19, 2024
1 parent d846b4c commit 40e48c9
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 1 deletion.
63 changes: 62 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,62 @@
In progress
# Starwalkers 🚀

![Logo Starwalkers](img/starwalkers_banner.png)

## Overview 🛸

Welcome to Starwalkers, a text-based space adventure where you command a fleet of starships! Build your fleet, explore the cosmos, engage in tactical battles, and support your friends by sending credits.

## Features ✨

- **Build Your Fleet:** Purchase and customize starships to enhance your fleet's capabilities.
- **Tactical PvE Battles:** Challenge computer-controlled enemies in strategic text-based combat.
- **Support Friends:** Send credits to friends to help them on their journey.

## Security 🔐

Starwalkers prioritizes the security of player accounts through the following measures:

- **Password Encryption:** User passwords are securely encrypted using bcrypt hashing algorithm.
- **Database Access:** Access to user data is managed through secure SQLite database connections.
- **Authentication:** Players must create an account with a unique username and securely encrypted password.

## How to Play 🎮

1. **Installation:**
- Clone the repository: `git clone https://github.com/jumitti/starwalkers.git`
- Install dependencies: `pip install -r requirements.txt`

2. **Launching the Game:**
- Navigate to the project directory.
- Run the game: `streamlit run starwalkers_streamlit.py`

3. **Running Backup Script:**
- For database backup, run `python backup.py` in parallel to ensure data safety during updates or unexpected events.

4. **Gameplay Tips:**
- Purchase new ships to expand and strengthen your fleet.
- Explore different sectors to discover valuable resources and artifacts.
- Engage in text-based PvE combat to earn rewards and progress.

## Future Updates 🔮

We're continuously enhancing Starwalkers to provide a richer text-based gaming experience:

- **Marketplace:** Soon, trade ships and resources with other players through the marketplace.
- **Progression and Upgrades:** Enhance your fleet's capabilities with future upgrade options.
- **Expanded Gameplay:** Look forward to more dynamic features and challenges.

Stay tuned for updates!

## Support 🛠️

For any inquiries or feedback, please contact us with [Issues](https://github.com/Jumitti/starwalkers/issues). We'd love to hear from you!

## Credits 🪪

- **[Julien Minniti](https://github.com/Jumitti)**: Lead developer and creator of Starwalkers Streamlit and Telegram Bot.
- **[Gametoy20](https://github.com/Gametoy20)**: Original game concept creator and ongoing contributor.

## License 📜

This project is licensed under the [MIT License](LICENSE).
Binary file added img/starwalkers_banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 40e48c9

Please sign in to comment.