Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
CGJennings committed Apr 27, 2021
0 parents commit 2b9a273
Show file tree
Hide file tree
Showing 1,509 changed files with 298,318 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitattributes
@@ -0,0 +1,2 @@
# Auto detect text files and perform LF normalization
* text=auto
16 changes: 16 additions & 0 deletions .gitignore
@@ -0,0 +1,16 @@
# NB cache and build output
**/nbproject/private/
**/nbproject/Makefile-*.mk
**/nbproject/Package-*.bash
build/
nbbuild/
dist/
nbdist/
.nb-gradle/

# Log files
*.log

# Virtual machine crash logs
hs_err_pid*
nbproject/genfiles.properties
7 changes: 7 additions & 0 deletions LICENSE.txt
@@ -0,0 +1,7 @@
Copyright 2006-2021 Christopher G. Jennings

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.
38 changes: 38 additions & 0 deletions README.md
@@ -0,0 +1,38 @@
# Strange Eons 3

[Strange Eons](https://strangeeons.cgjennings.ca) is a popular tool for creating and customizing components for paper-based games.

Currently runs only under Java 1.8 (support for later versions is in progress).

User documentation is managed in a [separate repository](https://github.com/CGJennings/se3docs).

## Hacking the code

Contributions (pull requests) are welcome. By making a pull request or otherwise contributing code or other data, you agree that your contribution can be combined with, and made available under the same [license terms](LICENSE.txt) as, the rest of the project.

### Tools

For non-trivial changes consider using the free [Apache NetBeans IDE](https://netbeans.apache.org/). Several interface elements (dialog boxes, etc.) use the NetBeans interface design tools, which insert (clearly marked) generated code into the class source files. Generated code **must not** be modified by hand, as any changes are overwritten automatically when the file is next opened in the design tool.

### There be dragons

I don't want to deter anyone from contributing, but I do want to give fair warning on a few points before you dive in:

Strange Eons began years ago as a simple editor for a single type of game card, with some features meant to help users find more creative designs. These early versions were developed to support research connected to my doctoral dissertation, and contain some of the first Java code I ever wrote. Although it has grown beyond its humble beginnings, as you might expect it contains some... sharp corners and unfortunate choices.

### Organization

Source code is found under `src`, organized into standard Java packages. Here is an outline:

`ca.cgjennings.*`
Contains the bulk of the application code. The application proper is mostly found under `ca.cgjennings.apps.arkham.*`. (The name `arkham` is historic in origin; the original app created characters for a board game called Arkham Horror.)

`gamedata.*`
Contains only those classes used to register new content with the application.

`resources.*`
Contains binary resources, string tables, and the libraries that support scripted plugins. Also contains a few classes related to loading and managing those resources, such as `ResourceKit`, `Settings`, and `Language`.

## License information

Original source code in this repository is licensed under an [MIT license](LICENSE.txt). Third party components are licensed under the terms in the relevant source files and/or their description in the About dialog box.
73 changes: 73 additions & 0 deletions build.xml
@@ -0,0 +1,73 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- You may freely edit this file. See commented blocks below for -->
<!-- some examples of how to customize the build. -->
<!-- (If you delete it and reopen the project it will be recreated.) -->
<!-- By default, only the Clean and Build commands use this build script. -->
<!-- Commands such as Run, Debug, and Test only use this build script if -->
<!-- the Compile on Save feature is turned off for the project. -->
<!-- You can turn off the Compile on Save (or Deploy on Save) setting -->
<!-- in the project's Project Properties dialog box.-->
<project name="strange-eons" default="default" basedir=".">
<description>Builds, tests, and runs the project strange-eons.</description>
<import file="nbproject/build-impl.xml"/>
<!--
There exist several targets which are by default empty and which can be
used for execution of your tasks. These targets are usually executed
before and after some main targets. They are:
-pre-init: called before initialization of project properties
-post-init: called after initialization of project properties
-pre-compile: called before javac compilation
-post-compile: called after javac compilation
-pre-compile-single: called before javac compilation of single file
-post-compile-single: called after javac compilation of single file
-pre-compile-test: called before javac compilation of JUnit tests
-post-compile-test: called after javac compilation of JUnit tests
-pre-compile-test-single: called before javac compilation of single JUnit test
-post-compile-test-single: called after javac compilation of single JUunit test
-pre-jar: called before JAR building
-post-jar: called after JAR building
-post-clean: called after cleaning build products
(Targets beginning with '-' are not intended to be called on their own.)
Example of inserting an obfuscator after compilation could look like this:
<target name="-post-compile">
<obfuscate>
<fileset dir="${build.classes.dir}"/>
</obfuscate>
</target>
For list of available properties check the imported
nbproject/build-impl.xml file.
Another way to customize the build is by overriding existing main targets.
The targets of interest are:
-init-macrodef-javac: defines macro for javac compilation
-init-macrodef-junit: defines macro for junit execution
-init-macrodef-debug: defines macro for class debugging
-init-macrodef-java: defines macro for class execution
-do-jar: JAR building
run: execution of project
-javadoc-build: Javadoc generation
test-report: JUnit report generation
An example of overriding the target for project execution could look like this:
<target name="run" depends="strange-eons-impl.jar">
<exec dir="bin" executable="launcher.exe">
<arg file="${dist.jar}"/>
</exec>
</target>
Notice that the overridden target depends on the jar target and not only on
the compile target as the regular run target does. Again, for a list of available
properties which you can use, check the target you are overriding in the
nbproject/build-impl.xml file.
-->
</project>
Binary file not shown.
Binary file added lib/code-editor.jar
Binary file not shown.
Binary file added lib/j2k.jar
Binary file not shown.
Binary file added lib/jar-loader.jar
Binary file not shown.
Binary file added lib/layout-mig.jar
Binary file not shown.
Binary file added lib/layout-river.jar
Binary file not shown.
4 changes: 4 additions & 0 deletions lib/nblibraries.properties
@@ -0,0 +1,4 @@
libs.CopyLibs.classpath=\
${base}/CopyLibs/org-netbeans-modules-java-j2seproject-copylibstask.jar
libs.CopyLibs.displayName=CopyLibs Task
libs.CopyLibs.prop-version=3.0
Binary file added lib/spelling.jar
Binary file not shown.
Binary file added lib/strange-rhino.jar
Binary file not shown.

0 comments on commit 2b9a273

Please sign in to comment.