Added CONTRIBUTING.md file to the 1.7.10 repo and updated the README.md file.
This commit is contained in:
bconlon
parent
b82974b256
commit
27fe25454d
28
CONTRIBUTING.md
Normal file
28
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
### Getting started for programmers
|
||||
We're excited to hear that you're interested in contributing to the Aether!
|
||||
|
||||
Before getting started, you'll need to install the latest 64-bit version of the OpenJDK 8 for your environment.
|
||||
- Windows users: We **strongly** recommend you use the Hotspot OpenJDK 8 builds provided by the [AdoptOpenJDK project](https://adoptopenjdk.net/) instead of the builds provided by Oracle.
|
||||
- macOS and Linux users: If you are already using a package manager, OpenJDK builds should be present in your software repositories. If not, we recommend using [SDKMan](https://sdkman.io/) to install the Hotspot OpenJDK 8 builds provided by the [AdoptOpenJDK](https://adoptopenjdk.net/) project.
|
||||
|
||||
We strongly recommend you use [IntelliJ IDEA Community Edition](https://www.jetbrains.com/idea/) when making code contributions. While other IDEs may work (in theory, anyways), support is spotty and you will often run into issues and other roadblocks. If you're not familiar with setting up IntelliJ IDEA for use with ForgeGradle projects, cpw has created a setup video which runs over a few of the basics of ForgeGradle [here](https://www.youtube.com/watch?v=PfmlNiHonV0).
|
||||
|
||||
If you have any questions or issues, or would just like to discuss Aether development, feel free to [join us on Discord](https://discord.gg/HYG3VPj).
|
||||
|
||||
### Creating merge requests
|
||||
Please make sure before opening a merge request that:
|
||||
|
||||
- Your merge request has an overview of the changes it makes, along with a link to the open issue(s) it resolves, if applicable.
|
||||
- Your changes include appropriate documentation and conform to our style guidelines.
|
||||
- If your merge request contains multiple commits, that you squash them before submitting.
|
||||
- You state in the description of your merge request that you agree to the Contributor License Agreement (CLA) found below.
|
||||
|
||||
### Contributor License Agreement
|
||||
By submitting code, assets, or documentation to the repository you are hereby agreeing that:
|
||||
|
||||
- You grant Gilded Games and other users the right to use your contributions under one of the following respective licenses:
|
||||
- [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) for assets in `/src/main/java/resources` and wiki pages. Older assets in the Aether project are licensed under the All Rights Reserved terms. If you are contributing new assets or updating existing assets, they will be licensed under the newer CC BY-SA 4.0.
|
||||
- [GNU GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html) for code or other changes.
|
||||
- Your contributions are of your own work and are free of legal restrictions (such as patents or copyrights).
|
||||
|
||||
If you have any questions about these terms, please [get in contact with us](https://aether.gildedgames.com/support). **If you do not agree to these terms, please do not submit contributions to this repository.**
|
||||
86
README.md
86
README.md
|
|
@ -1,40 +1,74 @@
|
|||
<img src="http://i.imgur.com/r0ztn.png" >
|
||||
|
||||
# The Aether
|
||||
[](https://www.gnu.org/licenses/gpl-3.0.en.html)
|
||||
[](https://creativecommons.org/licenses/by-sa/4.0/)
|
||||
|
||||
Gilded Games presents the original Aether mod! Up to date for modern Minecraft versions and fully compatible with multiplayer! The Aether is a dimension high in the sky composed of floating islands! Ascend through a Glowstone portal and begin a new survival adventure packed with new ores, mythical creatures and perilous Dungeons! All you need to do is build a Glowstone frame and add water to light the mystical portal, step in and you'll be transported immediately to the luscious hostile paradise known as the Aether! Gilded Games has ensured to keep The Aether as close to the original mod from 2011 as possible, while continuing to work on the sequel, Aether II.
|
||||
|
||||
# Aether Legacy [](https://twitter.com/ModdingLegacy)
|
||||
[](https://discord.gg/qZcfwet)
|
||||
[](https://github.com/Modding-Legacy/Aether-Legacy/releases)
|
||||
[](https://github.com/Modding-Legacy/Aether-Legacy/blob/master/LICENSE)
|
||||
[](https://minecraft.curseforge.com/projects/aether-legacy/)
|
||||
## :heart: Support Gilded Games
|
||||
|
||||
[](https://minecraft.curseforge.com/projects/aether-legacy/files)
|
||||
[](https://patreon.com/GildedGames)
|
||||
[](https://discord.gg/YgTv7Vg)
|
||||
[](https://twitter.com/DevAether)
|
||||
|
||||
If you enjoy our work, [please consider making a pledge](https://patreon.com/GildedGames) today to help fund development and gain access to special perks. Every pledge goes directly into the development process and enables us to continue making the Minecraft mods you know and love.
|
||||
|
||||
* [**Website**](https://moddinglegacy.com)
|
||||
You can also support the Aether project and Gilded Games by telling your friends, joining our Discord server, and sharing our progress and announcements on social media. Every bit helps!
|
||||
|
||||
## 📖 Summary
|
||||
Aether II is indeed an amazing mod and shall continue to grow into something even greater. However, some people haven't played the original Aether mostly due to it being outdated and unavailable to the general public through official ways. Aether Legacy is a port of the original Aether mod that allows people to play the original experience on newer versions of Minecraft with more bug fixes, optimizations, mod & multiplayer support!
|
||||
## :package: Download the latest releases
|
||||
### "Stable" builds
|
||||
[](https://minecraft.curseforge.com/projects/the-aether-mod)
|
||||
[](https://minecraft.curseforge.com/projects/the-aether-mod)
|
||||
|
||||
## 🕹️ How to Play
|
||||
For all still new to the experience of the Aether (be it Aether I/Aether II) to get to the Aether you must make a portal frame using Glowstone. From there a water bucket is needed to get the portal going and from there you are ready to head to the Aether.
|
||||
We use Curseforge to publish **stable builds** of the Aether for Minecraft. You can download the latest stable builds from our [official page found here](https://minecraft.curseforge.com/projects/the-aether-mod) without signing up for an account, and even install the Aether for Minecraft using the [Twitch Launcher](https://www.curseforge.com/twitch-client) with built-in integration for Curseforge mods. We recommend using our stable Curseforge releases for most people.
|
||||
|
||||
## 🏆 Goal
|
||||
The goal of this project is to help show how much the Aether has grown from then to now. With this project it should help bring more appreciation towards Aether II and the amount of dedication Gilded Games is putting out to make it as outstanding as it can ever be.
|
||||
### Bleeding edge builds
|
||||
[](https://jenkins.gildedgames.com/blue/organizations/jenkins/The-Aether/activity)
|
||||
|
||||
## ⚠️ Disclaimer
|
||||
There's only 2 programmers, with limited time, so if you find any bugs we do apologize. Please list all bugs on the issue tracker and a patch will be done every other week. Also, we are not adding any new content at all to keep the "legacy" in Aether Legacy.
|
||||
If you're feeling a bit more adventurous (or a developer has suggested you to do so), we provide **bleeding edge builds** which are produced on [our official Jenkins instance](https://jenkins.gildedgames.com/blue/organizations/jenkins/The-Aether/activity). These builds are very frequently created by an automatic service and contain the latest available code without undergoing any form of quality control. We do not generally recommend users use these builds as they may contain serious issues and will not generally receive support.
|
||||
|
||||
## ✏️ Contributors
|
||||
Thanks so much to these people keep Aether alive.
|
||||
## :bug: Report bugs or other issues
|
||||
If you're running into bugs or other problems, feel free to open an issue on our [issue tracker](https://gitea.gildedgames.com/GildedGames/The-Aether/issues). When doing so, we ask that you provide the following information:
|
||||
|
||||
## 🌐 Translations
|
||||
If you are interested in translating, come chat with us on Discord and we'll let you know how to go about it!
|
||||
- The exact version of the Aether you are running, such as `1.7.10-1.1.0`, and the version of Forge you are using, such as `10.13.4.1558`. Please do not state "the latest stable release" or "latest Forge".
|
||||
- If your issue is a bug or otherwise unexpected behavior, state what you expected to happen.
|
||||
- If your issue is a crash, attach the latest client or server log and the complete crash report as a file.
|
||||
- If your issue only occurs with other mods/plugins installed, list the exact mod/plugin versions installed.
|
||||
|
||||
- [x] English (en_US)
|
||||
- [x] Spanish (es_MX) - Translations by [@Aer-ink](https://github.com/Aer-ink)
|
||||
- [ ] French (fr_FR)
|
||||
- [ ] German (de_DE)
|
||||
- [ ] Chinese (zh_CH) - Translations by [@ETStareak](https://github.com/ETStareak)
|
||||
Make sure to keep your issue's description clear and concise. Your issue's title should also be easy to digest, giving our developers and reporters a good idea of what's wrong without including too many details. Failure to follow any of the above may result in your issue being closed.
|
||||
|
||||
- [x] English Upside Down - (ud_UD) Translations by [@The-Fireplace](https://github.com/The-Fireplace)
|
||||
## :wrench: Contribute to the project
|
||||
Looking to contribute to the project? We ask that you read over our [Contributor's Guide](https://gitea.gildedgames.com/GildedGames/The-Aether/src/branch/1.7.10/CONTRIBUTING.md) for more details and our Contributor License Agreement (CLA) before getting started.
|
||||
|
||||
Not sure what to help with? Take a look at our issue tracker for some ideas! [Here's a quick link](https://gitea.gildedgames.com/GildedGames/The-Aether/issues?label_name%5B%5D=Contributions+Welcome) which shows all the currently open issues that we'd love some help on.
|
||||
|
||||
## :scroll: License information
|
||||
If you're wanting to create a gameplay video/review, extension or addon, parody, or any other fan work of your own for the Aether, go for it! We love seeing the content our community creates, and we hope to make it as welcoming as possible for everyone. We ask however that if you are using code or assets from The Aether project that you adhere to the licenses below, and that you please don't advertise using our brand. If you're interested in sponsoring The Aether project or Gilded Games or wish to otherwise use our brand, please [contact us](mailto:support@gildedgames.com).
|
||||
|
||||
The source code of The Aether mod for Minecraft 1.7+ is under the [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.en.html) license. **All assets of the The Aether for Minecraft 1.7+ (found in the [resources folder](https://gitea.gildedgames.com/GildedGames/The-Aether/src/branch/1.7.10/src/main/resources/assets)) are unlicensed and all rights are reserved to them by Gilded Games.**
|
||||
|
||||
[Wiki contributions](https://gitea.gildedgames.com/GildedGames/Aether-II/wiki) are under the [CC BY-SA 4.0 license](https://creativecommons.org/licenses/by-sa/4.0/) unless otherwise stated.
|
||||
|
||||
Previous versions of The Aether are not licensed freely and all rights are reserved to them by Gilded Games. Unlicensed assets are owned and copyrighted by their respective authors and all other rights to them are reserved by Gilded Games. If you would like to use
|
||||
our unlicensed assets, please [get in contact with us](mailto:support@gildedgames.com) for details.
|
||||
|
||||
## :star2: Special mentions
|
||||
### :speech_balloon: Translations
|
||||
The Aether project makes use of crowd sourced translations. The Aether is available in these languages thanks to the following contributors:
|
||||
|
||||
- Chinese (zh_CN, zh_TW) - Translations by: ETStareak, y830705
|
||||
- Dutch (nl_NL) - Translations by: Critical
|
||||
- French (fr_FR) - Translations by: lololoustau and Beethov46
|
||||
- German (de_DE)
|
||||
- Italian * (it_IT)
|
||||
- Korean * (ko_KR)
|
||||
- Polish * (pl_PL)
|
||||
- Romanian (ro_RO)
|
||||
- Russian (ru_RU) - Translations by: LeyxorCheysen, andreyalex1236, LunarP1, and zombi1944
|
||||
- Spanish * (es_MX) - Translations by: Aer-ink
|
||||
- Thai * (th_TH)
|
||||
- Ukranian * (uk_UK)
|
||||
|
||||
_\* Indicates only partial language support._
|
||||
|
||||
The above list is incomplete, and as such, if your name is missing from it, please contact us. **You can help translate The Aether Mod to additional languages by joining our team of avid translators [here](https://aether.oneskyapp.com/collaboration/project?id=158541).**
|
||||
|
|
|
|||
Loading…
Reference in a new issue