Apple-2-SW/lawless-legends
1
0
Fork 0
mirror of https://github.com/badvision/lawless-legends.git synced 2024-12-25 13:29:59 +00:00
Code Issues Projects Releases Wiki Activity

Corrected information about starting the program and download link

Browse Source
This commit is contained in:
Brendan Robert 2013-08-05 22:19:16 -05:00
parent f97f62c95f
commit b2d0405732
1 changed files with 13 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
OutlawEditor/README.md
View File

@ -3,6 +3,19 @@ Outlaw Editor
This is a multi-platform RPG game editor. It is written in (and requires) Java 7 and JavaFX 2.2 to run. There are no external dependencies, but it is important that you install JavaFX 2.2 as per Oracle's instructions so that the java runtime can find the JavaFX libraries automatically.
Download
--------
The most recent copy of Outlaw Editor (aka the Daily build) can be found here: http://8bitweapon.com/lawlesslegends/OutlawEditor/target/jfx/app/OutlawEditor-jfx.jar
Running the program
-------------------
There are no dependencies outside of JavaFX (which will be part of Java in the 8.0 release) so you can start the program by executing the jar file that is built in the target/jfx/app folder "OutlawEditor-jfx.jar" Depending on your platform you might be able to double-click it. Or you might have to drop to the commandline and issue this command after going to that directory, like so:
> java -jar OutlawEditor-jfx.jar
For more information about using Outlaw Editor, refer to the wiki. Don't forget to check the Example Content folder for some starter content that you can use to get a better feel of what you can do!
Building the program
--------------------
@ -11,20 +24,3 @@ First time building: Open the pom.xml file and double-check that you have the ja
If you have an IDE that understands Apache Maven projects, then open this project in your IDE and build from there. I cannot stress how much easier this is than doing things manually. But if you insist on doing it the hard way, then "mvn install" should be sufficient to build the program if you have already installed Maven 2 and it is in your bin path and properly configured.
Before you build the first time, you will see all kinds of compile errors all over the source tree. That's because part of the program gets generated during the build process. Try doing a clean build and see if that resolves the issues before jumping into panic.
Running the program
-------------------
There are no dependencies outside of JavaFX (which will be part of Java in the 8.0 release) so you can start the program by executing the jar file that is built in the target folder "OutlawEditor-1.0-SNAPSHOT.jar" Depending on your platform you might be able to double-click it. Or you might have to drop to the commandline and issue this command after going to that directory, like so:
> java -jar OutlawEditor-1.0-SNAPSHOT.jar
For more information about using Outlaw Editor, refer to the wiki. Don't forget to check the Example Content folder for some starter content that you can use to get a better feel of what you can do!
Getting daily builds
--------------------
I am currently working to set up a build server and create a home for daily builds. More news will be posted as it becomes available.