Skip to content

Commit

Permalink
Cleanup the markdown files and remove IntelliJ coding style jar
Browse files Browse the repository at this point in the history
  • Loading branch information
@RyanTheAllmighty
RyanTheAllmighty committed Feb 7, 2016
1 parent 5ad2225 commit fefb442
Show file tree
Hide file tree
Showing 5 changed files with 94 additions and 88 deletions.
4 changes: 2 additions & 2 deletions .gitignore
View file
Expand Up @@ -6,9 +6,9 @@
!/src/
!/macapp/
!/.gitignore
!/CHANGELOG.md
!/Jenkinsfile
!/LICENSE
!/pom.xml
!/IntelliJ-Coding-Style.jar
!/README.md
!/STYLE.md
!/CHANGELOG.md
6 changes: 2 additions & 4 deletions CHANGELOG.md
View file
@@ -1,7 +1,5 @@
Changelog
====================================

### 3.2.3.2
# Changelog

## 3.2.3.2
- Fix issue with linked/depends mods not cascading their changes to the mods they enable
- Fixed issue that gave a bad '32 bit Java on 64 bit Windows' warning when 64 bit Java was installed in the x86 directory
Binary file removed IntelliJ-Coding-Style.jar
View file
Binary file not shown.
129 changes: 67 additions & 62 deletions README.md
View file
@@ -1,43 +1,32 @@
ATLauncher
====================================
# ATLauncher

[![Build Status](https://build.atlcdn.net/buildStatus/icon?job=ATLauncher)](https://build.atlcdn.net/job/ATLauncher/)

### What is it?
## What is it?

ATLauncher is a Launcher for Minecraft which integrates multiple different ModPacks to allow you to download and install ModPacks easily and quickly.
ATLauncher is a Launcher for Minecraft which integrates multiple different ModPacks to allow you to download and install
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)

### Links
[ATLauncher Website](https://www.atlauncher.com)
## Coding Standards & Styling Guidelines
Please see the [STYLE.md](STYLE.md) file for coding standards and style guidelines.

[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 file for coding standards and style guidelines.

### Building

#### Windows

##### Requirements

###### Java Development Kit (JDK)

Download and install the latest version from [Oracle's Java Downloads page](http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html).

###### Apache Maven
## Building
### Windows
#### Requirements
##### Java Development Kit (JDK)
Download and install the latest version from
[Oracle's Java Downloads page](http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html).

##### Apache Maven
Install Apache Maven via the official [Apache Maven Install Docs](http://maven.apache.org/download.cgi#Installation).

###### launch4j

##### launch4j
Download and install [launch4j](http://sourceforge.net/projects/launch4j/files/launch4j-3/3.1.0-beta2/).

Make sure to add the directory containing launch4jc to your executable path which for me on 64bit Windows was:
Expand All @@ -46,66 +35,82 @@ Make sure to add the directory containing launch4jc to your executable path whic
C:\Program Files (x86)\Launch4j
```

### 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.
## 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.

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.

#### VERSION
This is a LauncherVersion object passed in the reserved, major, minor, revision ints for this version of the launcher. See the 'Versioning System' section below.
### VERSION
This is a LauncherVersion object passed in the reserved, major, minor, revision ints for this version of the launcher.
See the 'Versioning System' section below.

#### API_BASE_URL
This is a link to your server side API for processing of leaderboard times and pack installs. This is optional and can be removed. We do not give implementation code, this is your own doing.
### API_BASE_URL
This is a link to your server side API for processing of leaderboard times and pack installs. This is optional and can
be removed. 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.
### 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.

*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
This is a link to the create api command for the instance of [stikked](https://github.com/claudehohl/Stikked) is running (For instance http://www.mypaste.com/api/create/)
### PASTE_API_URL
This is a link to the create api command for the instance of [stikked](https://github.com/claudehohl/Stikked) is running
(For instance http://www.mypaste.com/api/create/)

*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.*

#### SERVERS
This is an array of [Server](https://github.com/ATLauncher/ATLauncher/blob/master/src/main/java/com/atlauncher/data/Server.java) type elements the launcher uses as a base to download files.
### SERVERS
This is an array of
[Server](https://github.com/ATLauncher/ATLauncher/blob/master/src/main/java/com/atlauncher/data/Server.java) type
elements the launcher uses as a base to download files.

#### LAUNCHER_NAME
### LAUNCHER_NAME
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.

### Versioning System
### 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.

## Versioning System
Starting with version 3.2.1.0 a new versioning system was put into place. It works off the following:

Reserved.Major.Minor.Revision.Build

So for 3.2.1.0.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 build number is optional and should be 0 on releases.
So for 3.2.1.0.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 build number is optional and should be 0 on releases.

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.

Build is used for beta releases allowing you to have higher version numbers but force users to update when the real release comes.

### Need Help/Have Questions?
Build is used for beta releases allowing you to have higher version numbers but force users to update when the real
release comes.

## Need Help/Have Questions?
If you have questions please don't hesitate to [contact us](https://www.atlauncher.com/contact-us/)

### 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.
## 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.

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.
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.
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.
43 changes: 23 additions & 20 deletions STYLE.md
View file
@@ -1,29 +1,32 @@
ATLauncher Coding Standards & Styling Guidelines
====================================
# ATLauncher Coding Standards & Styling Guidelines

So if you wish to submit any Pull Requests, please follow these coding standards. Styling guidelines are just how I like to have things styled, mainly relating to doc blocks and comments.
So if you wish to submit any Pull Requests, please follow these coding standards. Styling guidelines are just how I like
to have things styled, mainly relating to doc blocks and comments.

### Coding Standards
## Coding Standards

+ Please keep all line lengths to 120 characters and use 4 spaces rather than tab characters.
+ 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 use the IntelliJ-Coding-Style.jar for the project (if using IntelliJ) in order to keep all formatting consistent.
+ 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.
- Please keep all line lengths to 120 characters and use 4 spaces rather than tab characters.
- 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 use the IntelliJ-Coding-Style.jar for the project (if using IntelliJ) in order to keep all formatting
consistent.
- 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

+ 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 end in a full stop.
+ Make sure there is a blank line between any main doc block information and any @elements.
- 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 end in a full stop.
- Make sure there is a blank line between any main doc block information and any @elements.

#### Example
### Example
// Some comment. Which ends in a full stop.

/**
Expand Down

0 comments on commit fefb442

Please sign in to comment.