Skip to content

Commit

Permalink
Updated README, added CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
Flafla2 committed Nov 28, 2013
1 parent ccb0e7f commit e4e8a1e
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 1 deletion.
31 changes: 31 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
===CHANGELOG===

==V0.1.2 ALPHA==
FEATURES:
- Added a debug tool in Renderer.class that allows you to see all matrix operations currently pushed to the stack
- Adding Components is now undoable
- Added a test component for testing Entity pointers
- Added Open Map / Save Map dialogs, as well as a “Save Map As...” option
- Saving a map reminds you if the file exists and is being overwritten
FIXES:
- Removed parenting temporarily, as it was buggy and didn’t work
- Fixed buggy rotation
- The inspector is now slightly more stable, using Entity UUIDs instead of the Entity’s index in the EntityList for storage
- Fixed Entity pointers not being updated when the Entity that is pointed to is changed.
- Fixed a crash when saving a file if user-defined attributes are unavailable for some reason (NOTE: if this does occur the engine will have to guess if XML is used)
- Fixed a bug where the map would still zoom in and out when you scroll even if a window is currently selected
- Fixed a bug where R2DFileUtility.getJarPath() would not be formatted in UTF-8 (ex. spaces would be formatted as “%20”)
- Fixed a bug in the browser which wouldn’t load anything outside of Eclipse
MISC:
- Updated changelog formatting

==V0.1.1 ALPHA==
FEATURES:
- Changed build from packaging external jars to extracting them, allowing you to use the jar for both an API and a Runnable test jar.
FIXES:
- Hotfix fixing a fatal bug that doesn’t allow the editor to open
- Hotfix fixing a fatal error on macs if no icon is specified

==V1.0 ALPHA==
FEATURES:
- Initial Release
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,24 @@ This is my (Flafla2) game engine, Remote2D. Remote2D aims to borrow a lot of th

The ultimate goal is to have a 2D Java-based engine that makes it very easy to prototype new games, while still retaining a sense of control. Minimal core code should be required, and more focus should go into the game itself.

<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/deed.en_US"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by-nc-sa/3.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">Remote2D Engine</span> by <span xmlns:cc="http://creativecommons.org/ns#" property="cc:attributionName">Adrian Biagioli</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/deed.en_US">Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License</a>.
===INSTALLATION===
No explicit installation is required, however the natives files MUST be in a folder called “lib” (no quotes) in the SAME DIRECTORY as Remote2D.jar.

===TO LAUNCH===
Double click on Remote2D.jar. To use in your own engine import Remote2D.jar into the class path, and extend Remote2DGame. See the javadoc for more info.

===LIBRARIES INCLUDED===
Remote2D uses the following libraries, packaged inside of Remote2D.jar:
- LWJGL (Lightweight Java Game Library): http://www.lwjgl.org
- XOM: http://www.xom.nu
- Minlog: https://github.com/EsotericSoftware/minlog
- Macify: http://simplericity.org/macify/
- Paulscode Soundsystem: http://www.paulscode.com/forum/index.php?topic=4.0

===LICENSE===
All licenses, including Remote2D’s license and the licenses of the external libraries used, are included in the /LICENSE folder.

<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/deed.en_US"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by-nc-sa/3.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">Remote2D Engine</span> by <span xmlns:cc="http://creativecommons.org/ns#" property="cc:attributionName">Adrian Biagioli</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/deed.en_US">Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License</a>.

===JAVADOC===
The javadoc can be found in the release zip. Check that out at http://github.com/Flafla2/Remote2D-Engine/releases

0 comments on commit e4e8a1e

Please sign in to comment.