Skip to content

Commit

Permalink
Initial pass of updating README.
Browse files Browse the repository at this point in the history
  • Loading branch information
quincyjo committed Feb 1, 2025
1 parent 6d868f4 commit 1c8ed4b
Showing 1 changed file with 60 additions and 4 deletions.
64 changes: 60 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,68 @@ The current state of this project is as a personal project which I used locally,
and providing a more user friendly release. At present, this will take some effort to get familiar with and use. I plan
and hopefully making some nice quality of life improvements and expanding this readme in the future.

## Running (after local compilation)
## Modules

This project contains several modules that published and available for use within your own project.

### Core

Core module contains the core models and utilities of the project. This includes base models for Stardrop entities and
serialization tools.

```scala
libraryDependencies += "com.quincyjo" %% "stardrop-core" % version
```

### Alternative Textures

This module contains the models and serialization tools for the Alternative Textures (AT) mod type.
``

```scala
libraryDependencies += "com.quincyjo" %% "stardrop-alternative-textures" % version
```

### Custom Furniture

This module contains the models and serialization tools for the Custom Furniture (CF) mod type.

```scala
libraryDependencies += "com.quincyjo" %% "stardrop-custom-furniture" % version
```

### Converters

Finally, the `stardrop-converters` module contains tools for converting between different mod types.

```scala
libraryDependencies += "com.quincyjo" %% "stardrop-converters" % version
```

### Cli

The Cli module contains the command line interface for Stardrop and is not available as a dependency. Check
the [releases](https://github.com/quincyjo/stardrop/releases)
page for the latest version or [built it from source](#building-cli-from-source) yourself.

## [Building CLI From Source]

The SBT project comes with the [sbt-assembly](https://github.com/sbt/sbt-assembly) plugin which allows for the building
of a fat JAR file.

This can be built by running the following SBT command from within the project directory. The resulting JAR file will be
located at `./modules/cli/target/scala-2.13/stardrop.jar` assuming the CWD is the project root directory.

```
sbt cli/assembly
```

## Running the CLI JAR

See the available commands and their options.

```
java -jar ./stardrop-assembly-pre-release.jar --help
java -jar ./stardrop.jar --help
```

### Common flow for converting a CF mod into an AT mod
Expand All @@ -30,14 +86,14 @@ By default, this will output the exploded mod into an `[root director name] expl
root.

```
java -jar ./stardrop-assembly-pre-release.jar explode \
java -jar ./stardrop.jar explode \
"path/to/mod/root" \
--expand-furniture-front --copy-fourth-rotation
```

2. Convert the exploded MOD to AT (after spot checking sprites, such as the different layers)

```
java -jar ./stardrop-assembly-pre-release.jar convert --to AT \
java -jar ./stardrop.jar convert --to AT \
"path/to/mod/root/[root name] exploded" --read-furniture-front
```

0 comments on commit 1c8ed4b

Please sign in to comment.