Add readme.md

2024-06-23 18:57:06 +00:00 · 2024-06-23 18:57:06 +00:00 · c33390a73d
commit c33390a73d
1 changed files with 134 additions and 0 deletions
--- a/readme.md
+++ b/readme.md
@ -0,0 +1,134 @@
+# Dystopika Asset Project
+
+Hey choom,
+
+You're probably wondering what this project is all about. In a nutshell, this project was initiated by the [[CORTEX IMPLANT](https://corteximplant.com/)](https://corteximplant.com/) community and its friends. [CORTEX IMPLANT](https://corteximplant.com/) is a Cyberpunk community within the OBEY THE SYSTEM network. For this project, we're creating in-game billboards for the dystopian building game, *[Dystopika](https://dystopika.com/)*. Why, you ask? The Cyberpunk setting of our community aligns perfectly with the game, and we take great pleasure in providing cool and immersive content to players.
+
+## Installation
+
+To use our community assets in [Dystopika](https://dystopika.com/), simply follow these steps:
+
+- Download the [Dystopika](https://dystopika.com/)-ads folder from this repository.
+- Copy the contents of the [Dystopika](https://dystopika.com/)-ads folder.
+- Navigate to the My Documents/[Dystopika](https://dystopika.com/)/ImportAds directory on your computer.
+- Paste the copied files into the ImportAds folder. 
+
+If the ImportAds folder doesn't exist, you can create it manually. Once the files are in place, launch [Dystopika](https://dystopika.com/) and enjoy the new in-game billboards provided by the [CORTEX IMPLANT](https://corteximplant.com/) and Friends community.
+
+## Contributing
+
+We welcome your contributions to our project! Here's how you can get started:
+
+### How to Contribute via Git
+
+1. **Fork the Repository**  
+   Click the "Fork" button to create your own copy of the repository.
+
+2. **Clone Your Fork**  
+   Clone the forked repository to your local machine:
+
+   ```sh
+   git clone https://git.cyberwa.re/revengeday/[Dystopika](https://dystopika.com/)-asset-project.git
+   ```
+
+3. **Create a New Branch**  
+   Create a new branch for your feature or fix:
+
+   ```sh
+   cd [Dystopika](https://dystopika.com/)-asset-project
+   git checkout -b your-feature-branch
+   ```
+
+4. **Make Your Changes**  
+   Implement your feature or fix the issue.
+
+5. **Commit Your Changes**  
+   Commit your changes with a descriptive message:
+
+   ```sh
+   git add .
+   git commit -m "Describe your changes"
+   ```
+
+6. **Push to Your Fork**  
+   Push the changes to your forked repository:
+
+   ```sh
+   git push origin your-feature-branch
+   ```
+
+7. **Submit a Pull Request**  
+   Go to the original repository on https://git.cyberwa.re and submit a Pull Request with a clear description of your changes.
+   
+### No Git?
+
+No problem! If you're not familiar with Git, you can still contribute:
+
+1. **Create Your Graphic**  
+   Design the graphic you want to contribute.
+
+2. **Send It to Us**  
+   Send your graphic to our Fediverse account at [@revengeday@corteximplant.com](https://corteximplant.com/@revengeday). We'll take care of adding it to the repository.
+   
+### Contributing Designs
+
+For those contributing designs, please follow these guidelines:
+
+1. **Style**  
+   The style should remain Cyberpunk. Think neon lights, gritty textures, and futuristic elements.
+
+2. **Aspect Ratios and Sizes**  
+   To ensure the in-game ads look good, please adhere to the following aspect ratios and sizes:
+
+   | Aspect Ratio | Size      |
+   |--------------|-----------|
+   | 1:1          | 1280x1280 |
+   | 1:2          | 1280x2560 |
+   | 2:1          | 1280x640  |
+
+3. **Use Templates**  
+   In the `templates` folder, you will find pre-sized image files that you can use as a starting point for your designs.
+
+### Need Help?
+
+If you have questions or need assistance, feel free to open an issue or contact us directly. We look forward to your contributions! 🚀
+   
+## License
+
+By using the assets in this repository, you agree to the following terms:
+
+### Non-Commercial Use
+
+You are free to use, copy, and modify the assets for personal and educational purposes. Commercial use is strictly prohibited.
+
+### No Redistribution
+
+Uploading any of the assets in this repository to other websites or platforms is not permitted.
+
+### Copyright Protection
+
+Some graphics and logos included in this project are protected by copyright laws and cannot be used without explicit permission from the copyright holders. This includes, but is not limited to:
+
+- **[CORTEX IMPLANT](https://corteximplant.com/)**
+- **[NIGHT CITY BAR](https://nightcity.bar/)**
+- **[TOTENTANZ](https://totentanz.club/)**
+- **[REVENGEDAY](https://revenge.day/)**
+- **[CYBERWARE](https://cyberwa.re/)**
+- **[OBEY THE SYSTEM](https://obeythesystem.com/)**
+
+### Attribution
+
+If you use or modify any of the assets, please give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
+## Contact Information
+
+If you have any questions, need assistance, or want to share ideas, feel free to reach out to us:
+
+- **Email:** dystopika-asset-project@revenge.day
+- **Fediverse:** [@revengeday@corteximplant.com](https://corteximplant.com/@revengeday)
+
+You can also open an issue on our repository if you encounter any problems or have suggestions. We're here to help and look forward to your contributions! 🚀
+
+##Disclaimer
+
+This project is not partnered with, endorsed by, or in contact with the developers of the game **[Dystopika](https://dystopika.com/)**. All assets are fan-made and independently created.
+