chore: update dependencies and some documentation
This commit is contained in:
Ryan Dowling
parent
d832dd53ad
commit
1a16080768
4 changed files with 67 additions and 142 deletions
21
LICENSE_NEW
21
LICENSE_NEW
|
|
@ -1,21 +0,0 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2013-present Ryan Dowling and other contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
121
README.md
121
README.md
|
|
@ -1,7 +1,7 @@
|
|||
# ATLauncher
|
||||
|
||||
|
||||
[](https://atl.pw/discordfromgithub)
|
||||
[](https://atl.pw/discord)
|
||||
|
||||
## What is it
|
||||
|
||||
|
|
@ -10,14 +10,11 @@ ModPacks easily and quickly.
|
|||
|
||||
## Links
|
||||
|
||||
- [ATLauncher Website](https://www.atlauncher.com)
|
||||
- [ATLauncher Facebook](http://www.facebook.com/ATLauncher)
|
||||
- [ATLauncher Reddit](http://www.reddit.com/r/ATLauncher)
|
||||
- [ATLauncher Twitter](http://twitter.com/ATLauncher)
|
||||
|
||||
## Coding Standards & Styling Guidelines
|
||||
|
||||
Please see the [STYLE.md](STYLE.md) file for coding standards and style guidelines.
|
||||
- [ATLauncher Website](https://atlauncher.com)
|
||||
- [ATLauncher Discord](https://atl.pw/discord)
|
||||
- [ATLauncher Facebook](https://www.facebook.com/ATLauncher)
|
||||
- [ATLauncher Reddit](https://www.reddit.com/r/ATLauncher)
|
||||
- [ATLauncher Twitter](https://twitter.com/ATLauncher)
|
||||
|
||||
## Contributing to ATLauncher
|
||||
|
||||
|
|
@ -29,8 +26,11 @@ Please see the [TESTING.md](TESTING.md) file for information on how we write tes
|
|||
|
||||
## Prerequisites
|
||||
|
||||
In order to build ATLauncher, you will Java 8, 9, 10, 11 or 12. Java 8 is recommended since we
|
||||
compile to Java 8 compatability regardless.
|
||||
In order to build ATLauncher, you will need Java 8, 9, 10, 11 or 12. Java 8 is recommended since we compile to Java 8
|
||||
compatability regardless.
|
||||
|
||||
Everything else that's needed for the project is provided by Gradle, and accessed using the Gradle wrapper which can be
|
||||
invoked by using `./gradlew`.
|
||||
|
||||
## Building
|
||||
|
||||
|
|
@ -40,13 +40,11 @@ To build this project, simply run:
|
|||
./gradlew build
|
||||
```
|
||||
|
||||
This will build the application and output the resulting files for Windows, Linux and OSX in the
|
||||
`dist` directory.
|
||||
This will build the application and output the resulting files for Windows, Linux and OSX in the `dist` directory.
|
||||
|
||||
## Running in test
|
||||
|
||||
If you want to run the launcher while developing with it, you can use your IDE (if you have one) to
|
||||
do that for you.
|
||||
If you want to run the launcher while developing with it, you can use your IDE (if you have one) to do that for you.
|
||||
|
||||
Alternatively you can run:
|
||||
|
||||
|
|
@ -56,9 +54,9 @@ Alternatively you can run:
|
|||
|
||||
## Using VSCode
|
||||
|
||||
This project is setup to use [VSCode](https://code.visualstudio.com/) for development. You're free
|
||||
to use any other IDE that you're accustomed to (if any), but by using VSCode, you get the benefit
|
||||
of predefined tasks and launch commands.
|
||||
This project is setup to use [VSCode](https://code.visualstudio.com/) for development. You're free to use any other IDE
|
||||
that you're accustomed to (if any), but by using VSCode, you get the benefit of predefined tasks and launch commands as
|
||||
well as a list of extensions recommended for the project.
|
||||
|
||||
## Checking for dependency updates
|
||||
|
||||
|
|
@ -78,7 +76,7 @@ If you add new files, or update the `LICENSEHEADER` file, you can add that to al
|
|||
./gradlew updateLicenses
|
||||
```
|
||||
|
||||
To check that they're all correct, you can runthe below command:
|
||||
To check that they're all correct, you can run the below command:
|
||||
|
||||
```sh
|
||||
./gradlew checkLicenses
|
||||
|
|
@ -132,10 +130,10 @@ For an example, see the `DraculaContrast` theme which uses this method.
|
|||
## Plugging In Your Data
|
||||
|
||||
To get started with the code and plug in your own data, you need to edit the
|
||||
/src/main/java/com/atlauncher/data/Constants.java file.
|
||||
`/src/main/java/com/atlauncher/data/Constants.java` file.
|
||||
|
||||
By using this source code you don't get permissions to use our CDN/files/assets/modpacks. See the
|
||||
License section at the bottom for more.
|
||||
By using this source code you don't get permissions to use our CDN/files/assets/modpacks. See the License section at the
|
||||
bottom for more.
|
||||
|
||||
See below for explanations as to what each constant means.
|
||||
|
||||
|
|
@ -151,13 +149,12 @@ We do not give implementation code, this is your own doing.
|
|||
|
||||
### PASTE_CHECK_URL
|
||||
|
||||
This is a link to the url where an instance of [stikked](https://github.com/claudehohl/Stikked) is
|
||||
running (For instance http://www.mypaste.com) this is how the launcher knows if the paste was
|
||||
successful by checking the response from the API for the url of the software.
|
||||
This is a link to the url where an instance of [stikked](https://github.com/claudehohl/Stikked) is running
|
||||
(For instance <https://www.mypaste.com>) this is how the launcher knows if the paste was successful by checking the
|
||||
response from the API for the url of the software.
|
||||
|
||||
_Please note that the domain given above IS NOT REAL. You must install
|
||||
[stikked](https://github.com/claudehohl/Stikked) on your own domain and reference it, the domain is
|
||||
only there as an example of what a valid value is._
|
||||
_Please note that the domain given above IS NOT REAL. You must install [stikked](https://github.com/claudehohl/Stikked)
|
||||
on your own domain and reference it, the domain is only there as an example of what a valid value is._
|
||||
|
||||
### PASTE_API_URL
|
||||
|
||||
|
|
@ -175,30 +172,27 @@ This is the name of the launcher.
|
|||
|
||||
### How to make your data
|
||||
|
||||
To make the data the Launcher needs you will need to figure out your own server side way of doing
|
||||
that. You can create a system to do it automatically or you can manually do it by just popping the
|
||||
files on the server. The best way to get the file structure and contents is to examine the source
|
||||
code and the ATLauncher files it downloads.
|
||||
To make the data the Launcher needs you will need to figure out your own server side way of doing that. You can create a
|
||||
system to do it automatically or you can manually do it by just popping the files on the server. The best way to get the
|
||||
file structure and contents is to examine the source code and the ATLauncher files it downloads.
|
||||
|
||||
## Versioning System
|
||||
|
||||
Starting with version 3.2.1.0 a new versioning system was put into place. It works off the
|
||||
following:
|
||||
Starting with version 3.2.1.0 a new versioning system was put into place. It works off the following:
|
||||
|
||||
Reserved.Major.Minor.Revision.Stream
|
||||
|
||||
So for 3.2.1.0 the major number is 2 and minor number is 1 and revision number is 0. Reserved is
|
||||
used as a base, only incremented on complete rewrites. The stream is optional.
|
||||
So for 3.2.1.0 the major number is 2 and minor number is 1 and revision number is 0. Reserved is used as a base, only
|
||||
incremented on complete rewrites. The stream is optional.
|
||||
|
||||
Major should be incremented when large changes/features are made.
|
||||
|
||||
Minor should be incremented when small changes/features are made.
|
||||
|
||||
Revision should be incremented when there are no new features and only contains bug fixes for the
|
||||
previous minor.
|
||||
Revision should be incremented when there are no new features and only contains bug fixes for the previous minor.
|
||||
|
||||
Build is used for beta releases allowing you to have higher version numbers but force users to
|
||||
update when the real release comes.
|
||||
Build is used for beta releases allowing you to have higher version numbers but force users to update when the real
|
||||
release comes.
|
||||
|
||||
Stream is used to define if it's a "Release" or a "Beta". When not provided, it defaults to "Release".
|
||||
|
||||
|
|
@ -206,47 +200,38 @@ Stream is used to define if it's a "Release" or a "Beta". When not provided, it
|
|||
|
||||
The version can be updated in a single place in the `/src/main/resources/version` file.
|
||||
|
||||
The stream value doesn't need to be provided, but should only ever be "Beta". When a release is ready
|
||||
to go out, the stream should be removed from the version so that everything will automatically release.
|
||||
The stream value doesn't need to be provided, but should only ever be "Beta". When a release is ready to go out, the
|
||||
stream should be removed from the version so that everything will automatically release.
|
||||
|
||||
## Translating
|
||||
|
||||
ATLauncher is written for English speakers. All our translations are community run by those who
|
||||
take their time and submit updates to the text in a different language.
|
||||
ATLauncher is written for English speakers. All our translations are community run by those who take their time and
|
||||
submit updates to the text in a different language.
|
||||
|
||||
If you wish to help translate ATLauncher, please visit our page on
|
||||
[Crowdin](https://crowdin.com/project/atlauncher) and start translating.
|
||||
If you wish to help translate ATLauncher, please visit our page on [Crowdin](https://crowdin.com/project/atlauncher) and
|
||||
start translating.
|
||||
|
||||
### Updating the template file
|
||||
|
||||
If new strings are added to the launcher, the template file will need to be updated in order to
|
||||
take into account the new strings.
|
||||
If new strings are added to the launcher, the template file will need to be updated in order to take into account the
|
||||
new strings.
|
||||
|
||||
In order to do this, run `./gradlew generatePots` which will scan the source files and create a
|
||||
`build/gettext/translations.pot` file.
|
||||
|
||||
Note that out of the box, this will not generate in the correct format. The file should be opened
|
||||
with [POEdit](https://poedit.net/), which will automatically fix the file, which then you can save
|
||||
to `translations.pot` in the root directory, which will then get picked up by Crowdin.
|
||||
|
||||
## Need Help/Have Questions?
|
||||
|
||||
If you have questions please don't hesitate to [contact us](https://www.atlauncher.com/contact-us/)
|
||||
Note that out of the box, this will not generate in the correct format. The file should be opened with
|
||||
[POEdit](https://poedit.net/), which will automatically fix the file, which then you can save to `translations.pot` in
|
||||
the root directory, which will then get picked up by Crowdin.
|
||||
|
||||
## License
|
||||
|
||||
This work is licensed under the GNU General Public License v3.0. To view a copy of this license,
|
||||
visit <http://www.gnu.org/licenses/gpl-3.0.txt>.
|
||||
This work is licensed under the GNU General Public License v3.0. To view a copy of this license, visit
|
||||
<http://www.gnu.org/licenses/gpl-3.0.txt>.
|
||||
|
||||
A simple way to keep in terms of the license is by forking this repository and leaving it open
|
||||
source under the same license. We love free software, seeing people use our code and then not share
|
||||
the code, breaking the license, is saddening. So please take a look at the license and respect what
|
||||
we're doing.
|
||||
A simple way to keep in terms of the license is by forking this repository and leaving it open source under the same
|
||||
license. We love free software, seeing people use our code and then not share the code, breaking the license, is
|
||||
saddening. So please take a look at the license and respect what we're doing.
|
||||
|
||||
Also, while we cannot enforce this under the license, you cannot use our CDN/files/assets/modpacks
|
||||
on your own launcher. Again we cannot enforce this under the license, but needless to say, we'd be
|
||||
very unhappy if you did that and really would like to leave cease and desist letters as a last
|
||||
resort.
|
||||
|
||||
If you have any questions or concerns as to the license or what we consider to be good and bad in
|
||||
your clone/fork, please use the contact link in the section right above this one.
|
||||
Also, while we cannot enforce this under the license, you cannot use our CDN/files/assets/modpacks on your own launcher.
|
||||
Again we cannot enforce this under the license, but needless to say, we'd be very unhappy if you did that and really
|
||||
would like to leave cease and desist letters as a last resort.
|
||||
|
|
|
|||
39
STYLE.md
39
STYLE.md
|
|
@ -1,39 +0,0 @@
|
|||
# ATLauncher coding standards & styling guidelines
|
||||
If you wish to submit a pull request to ATLauncher then please take a look at the below sections about our coding and
|
||||
styling standards before make said pull request.
|
||||
|
||||
## Coding standards
|
||||
Coding standards are absolutely essential to having your pull request approved. While we may not close your pull
|
||||
request if it doesn't follow these coding standards, we most likely will delay merging it until compliant.
|
||||
|
||||
- Please keep all line lengths to 120 characters.
|
||||
- Please don't use tabs, use 4 spaced tabs.
|
||||
- Please keep all variables at the top of the class.
|
||||
- Please keep all inner classes at the bottom.
|
||||
- Please don't use star imports.
|
||||
- Please mark all classes that are to be de/serialized with Gson with the @Json annotation for other developers.
|
||||
- Please update the CHANGELOG.md file when fixing/adding something so it's easier to keep track of than git commits.
|
||||
Feel free to add in a 'by MyUsername' to the end of the changes you've made.
|
||||
- Please don't do large commits. My preference is a single commit for a single fix/addition rather than bundled up
|
||||
commits.
|
||||
- Please use final where possible.
|
||||
- Please make sure all files contain the GNU GPLv3 license at the top of the file.
|
||||
|
||||
## Styling guidelines
|
||||
Styling guidelines are just how we prefer to have things styled, mainly relating to doc blocks and comments. Not
|
||||
following these guidelines will not get your pull requests denied as they're less important than our actual coding
|
||||
standards listed above.
|
||||
|
||||
- Make sure all doc block information has a full stop at the end.
|
||||
- Make sure all doc block @ elements don't have a full stop at the end.
|
||||
- Make sure all comments not in doc blocks don't have a full stop at the end.
|
||||
- Make sure there is a blank line between any main doc block information and any @elements.
|
||||
|
||||
### Example
|
||||
// Some comment. Which doesn't end in a full stop
|
||||
|
||||
/**
|
||||
* Where the magic happens. Notice I end in a full stop.
|
||||
*
|
||||
* @param arguments all the arguments passed in from the command line, notice I don't end in a full stop
|
||||
*/
|
||||
28
build.gradle
28
build.gradle
|
|
@ -5,7 +5,7 @@ buildscript {
|
|||
mavenCentral()
|
||||
}
|
||||
dependencies {
|
||||
classpath 'org.mini2Dx:gettext-gradle-plugin:1.1.0'
|
||||
classpath 'org.mini2Dx:gettext-gradle-plugin:1.1.1'
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -17,16 +17,16 @@ plugins {
|
|||
id 'edu.sc.seis.macAppBundle' version '2.3.0'
|
||||
id 'edu.sc.seis.launch4j' version '2.4.6'
|
||||
id 'net.minecrell.licenser' version '0.4.1'
|
||||
id "com.github.ben-manes.versions" version "0.21.0"
|
||||
id 'com.github.ben-manes.versions' version '0.28.0'
|
||||
}
|
||||
|
||||
apply plugin: "org.mini2Dx.gettext"
|
||||
apply plugin: 'org.mini2Dx.gettext'
|
||||
|
||||
sourceCompatibility = '1.8'
|
||||
targetCompatibility = '1.8'
|
||||
|
||||
group = 'com.atlauncher'
|
||||
version = rootProject.file('src/main/resources/version').text.trim().replace(".Beta", "")
|
||||
version = rootProject.file('src/main/resources/version').text.trim().replace('.Beta', '')
|
||||
|
||||
repositories {
|
||||
mavenCentral()
|
||||
|
|
@ -40,22 +40,22 @@ repositories {
|
|||
}
|
||||
|
||||
dependencies {
|
||||
implementation 'com.google.code.gson:gson:2.8.5'
|
||||
implementation 'com.google.code.gson:gson:2.8.6'
|
||||
implementation 'org.tukaani:xz:1.8'
|
||||
implementation 'com.mojang:authlib:1.5.21'
|
||||
implementation 'net.iharder:base64:2.3.9'
|
||||
implementation 'com.github.Vatuu:discord-rpc:1.6.2'
|
||||
implementation 'net.sf.jopt-simple:jopt-simple:5.0.4'
|
||||
implementation 'org.zeroturnaround:zt-zip:1.13'
|
||||
implementation 'com.squareup.okhttp3:okhttp:4.0.1'
|
||||
implementation 'net.mikehardy:google-analytics-java:2.0.8'
|
||||
implementation 'io.sentry:sentry:1.7.24'
|
||||
implementation 'org.mini2Dx:gettext-lib:1.1.0'
|
||||
implementation 'org.apache.logging.log4j:log4j-api:2.12.0'
|
||||
implementation 'org.apache.logging.log4j:log4j-core:2.12.0'
|
||||
implementation 'org.zeroturnaround:zt-zip:1.14'
|
||||
implementation 'com.squareup.okhttp3:okhttp:4.7.2'
|
||||
implementation 'net.mikehardy:google-analytics-java:2.0.11'
|
||||
implementation 'io.sentry:sentry:1.7.30'
|
||||
implementation 'org.mini2Dx:gettext-lib:1.1.1'
|
||||
implementation 'org.apache.logging.log4j:log4j-api:2.13.3'
|
||||
implementation 'org.apache.logging.log4j:log4j-core:2.13.3'
|
||||
implementation 'com.sangupta:murmur:1.0.0'
|
||||
implementation 'org.apache.commons:commons-lang3:3.9'
|
||||
implementation 'com.formdev:flatlaf:0.36'
|
||||
implementation 'org.apache.commons:commons-lang3:3.10'
|
||||
implementation 'com.formdev:flatlaf:0.37'
|
||||
implementation 'com.github.pack200:pack200:d5fd0807d6'
|
||||
|
||||
testImplementation 'org.junit.jupiter:junit-jupiter-api:5.5.0'
|
||||
|
|
|
|||
Loading…
Reference in a new issue