Skip to content

Latest commit

 

History

History
174 lines (129 loc) · 4.52 KB

README.md

File metadata and controls

174 lines (129 loc) · 4.52 KB
Raw

JXM

JXM (Java XOPSManipulator) is a Java library to handle data related to X operations.

Requirements

Java ≥ 17

Installation

Maven

BD1 module

Supports operations of the BD1 format.

<groupId>com.github.dabasan</groupId>
<artifactId>jxm-bd1</artifactId>
<version>2.2.0</version>

MIF module

Supports operations of the MIF format.

<groupId>com.github.dabasan</groupId>
<artifactId>jxm-mif</artifactId>
<version>2.2.0</version>

PD1 module

Supports operations of the PD1 format.

<groupId>com.github.dabasan</groupId>
<artifactId>jxm-pd1</artifactId>
<version>2.2.0</version>

Properties module

Supports operations of

  • XMS (X operations Mod Supporter)
    • IDS (Individual weapon data)
    • XGS (Set of all weapon data)
    • XCS (Set of all character data)
  • OpenXOPS source code format
    • Weapon data
    • Character data
  • X operations binaries
    • 0.96
    • 0.96t
    • 0.97ft
    • 0.975t
    • olt18f2
    • olt19f2
<groupId>com.github.dabasan</groupId>
<artifactId>jxm-properties</artifactId>
<version>2.2.0</version>

Code sample

/**
 * Readme code sample for the JXM repo
 *
 * @author maeda6uiui
 */
public class ReadmeSample {
    public static void main(String[] args) {
        //Load BD1 file
        BD1Manipulator manipulator;
        try {
            manipulator = new BD1Manipulator("./Data/map.bd1");
        } catch (IOException e) {
            e.printStackTrace();
            return;
        }

        //Get the number of blocks
        int numBlocks = manipulator.getNumBlocks();
        System.out.println(numBlocks);

        //Get all filenames of the textures
        manipulator.getTextureFilenames().forEach((k, v) -> System.out.printf("%d: %s\n", k, v));

        //Change texture filenames
        manipulator.setTextureFilename(0, "test.bmp");
        manipulator.setTextureFilename(1, "test_2.bmp");

        //Transform the map
        //The operation order is
        //rescaling -> rotation around the y-axis -> translation
        manipulator
                .translate(0.0f, 100.0f, 0.0f)
                .rotY((float) Math.toRadians(45))
                .rescale(1.0f, 2.0f, 1.0f)
                .applyTransformation();

        //Invert z-axis (create mirrored map)
        manipulator.invertZ();

        try {
            //Save as BD1
            manipulator.saveAsBD1("./Data/map2.bd1");

            //Save as OBJ
            manipulator.saveAsOBJ(
                    "./Data/map2.obj",
                    "./Data/map2.mtl",
                    "map2.mtl",
                    true);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

Other code samples

See jxm-samples-v2 for the code samples of JXM v2 (current version).

Previous versions

For developers

How to run tests

You can run tests with mvn test if you have Maven installed.

Place required files under the TestData folder of each module before executing tests. Some files are not available on GitHub due to copyright reasons. Listed below is the list of files you have to prepare by yourself:

BD1 module

  • ./jxm-bd1/TestData/SnowBase/map.bd1
  • ./jxm-bd1/TestData/SnowBase/map_2.bd1
  • ./jxm-bd1/TestData/TrainingYard/map.bd1

SnowBase/map.bd1 is a standard map file of SNOW BASE (from data/map2/temp.bd1). SnowBase/map_2.bd1 can be any map file as long as it is different from SnowBase/map.bd1.

TrainingYard/map.bd1 is a standard map file of TRAINING YARD (from data/map0/temp.bd1).

PD1 module

  • ./jxm-pd1/TestData/SnowBase/point.pd1
  • ./jxm-pd1/TestData/SnowBase/point_2.pd1

point.pd1 is a standard point file of SNOW BASE_EXT (from data/map2/ext.pd1). point_2.pd1 can be any point file as long it is different from point.pd1.

Properties module

  • ./jxm-properties/TestData/Character/xops0975t.exe
  • ./jxm-properties/TestData/Weapon/xops0975t.exe
  • ./jxm-properties/TestData/XOPS/Original/xops096.exe
  • ./jxm-properties/TestData/XOPS/Original/xops096t.exe
  • ./jxm-properties/TestData/XOPS/Original/xops097ft.exe
  • ./jxm-properties/TestData/XOPS/Original/xops0975t.exe
  • ./jxm-properties/TestData/XOPS/Original/xopsolt18f2.exe
  • ./jxm-properties/TestData/XOPS/Original/xopsolt19f2.exe