Skip to content

Commit a90dc39

Browse files
committed
Rename package, ensure line wraps in README
1 parent c245ecd commit a90dc39

File tree

4 files changed

+25
-13
lines changed

4 files changed

+25
-13
lines changed

README.md

+22-10
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
11
# Fallout Curve Table
2-
Given a (set of) curve table files from Fallout 76, generates a format usable by the [CurveTable template](https://fallout.fandom.com/wiki/Template:CurveTable) on [Nukapedia](https://fallout.fandom.com/). Prevents typos and makes the whole process a lot easier.
2+
Given a (set of) curve table files from Fallout 76, generates a format usable by the
3+
[CurveTable template](https://fallout.fandom.com/wiki/Template:CurveTable) on
4+
[Nukapedia](https://fallout.fandom.com/).
5+
Prevents typos and makes the whole process a lot easier.
36

4-
Curve table files are JSON files and can be extracted from the `SeventySix - Startup.ba2` file using a tool such as [Bethesda Archive Extractor](https://www.nexusmods.com/skyrimspecialedition/mods/974).
7+
Curve table files are JSON files and can be extracted from the `SeventySix - Startup.ba2` file using a tool such as
8+
[Bethesda Archive Extractor](https://www.nexusmods.com/skyrimspecialedition/mods/974).
59

610
## Usage
7-
1. Download the jar on [the releases page](https://github.com/FWDekker/fallout-curve-tables/releases).
8-
2. Open a terminal and navigate to where you downloaded the jar.
9-
3. Run the jar with `java -jar fallout-curve-table.jar [options]`. See below for a list of options.
11+
1. Download the archive for your system on
12+
[the releases page](https://github.com/FWDekker/fallout-curve-tables/releases).
13+
2. Unpack the archive in any folder.
14+
3. Open a terminal and navigate to the `bin/` folder in the extracted archive.
15+
4. Run the program with `falloutcurvetable [options]` (Windows) or `./falloutcurvetable [options]` (Linux/macOS).
16+
See below for a list of options.
1017

1118
### Options
1219
```
@@ -34,17 +41,22 @@ Usage: <main class> [options]
3441

3542
### Examples
3643
#### HP
37-
Let's say you have a directory `misc/curvetables/json/creatures/health/` containing the health curve tables for Fallout 76's creatures.
44+
Let's say you have a directory `misc/curvetables/json/creatures/health/` containing the health curve tables for
45+
Fallout 76's creatures.
3846
Each filename has the format `health_<creature>.json`.
39-
Then the following command generates the appropriate output for the [HP template](https://fallout.fandom.com/wiki/Template:Stats_creature_FO76/HP):
47+
Then the following command generates the appropriate output for the
48+
[HP template](https://fallout.fandom.com/wiki/Template:Stats_creature_FO76/HP):
4049
```bash
4150
java -jar fallout-curve-table.jar -s misc/curvetables/json/creatures/health/ -d my_output.txt --prefix "health_"
4251
```
4352

4453
#### DR
45-
Let's say you have a directory `misc/curvetables/json/creatures/armor/` containing the damage and energy resistance curve tables for Fallout 76's creatures.
46-
Each filename has the format `armor_<creature>_dr.json` or `armor_<creature>_er.json`, but you're only interested in those with the former.
47-
Then the following command generates the appropriate output for the [DR template](https://fallout.fandom.com/wiki/Template:Stats_creature_FO76/DR):
54+
Let's say you have a directory `misc/curvetables/json/creatures/armor/` containing the damage and energy resistance
55+
curve tables for Fallout 76's creatures.
56+
Each filename has the format `armor_<creature>_dr.json` or `armor_<creature>_er.json`, but you're only interested in
57+
those with the former.
58+
Then the following command generates the appropriate output for the
59+
[DR template](https://fallout.fandom.com/wiki/Template:Stats_creature_FO76/DR):
4860
```bash
4961
java -jar fallout-curve-table.jar -s misc/curvetables/json/creatures/armor/ -d my_output.txt --prefix "armor_" --suffix "_dr.json"
5062
```

build.gradle

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ compileJava.destinationDir = compileKotlin.destinationDir
1717
compileKotlin { kotlinOptions.jvmTarget = "11" }
1818

1919
application {
20-
mainClass.set("com.fwdekker.falloutcurvetable.MainKt")
20+
mainClass.set("com.fwdekker.falloutcurvetables.MainKt")
2121
}
2222
runtime {
2323
// Options

src/main/kotlin/com/fwdekker/falloutcurvetable/CurveTable.kt renamed to src/main/kotlin/com/fwdekker/falloutcurvetables/CurveTable.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.fwdekker.falloutcurvetable
1+
package com.fwdekker.falloutcurvetables
22

33
import com.beust.klaxon.Klaxon
44
import java.io.File

src/main/kotlin/com/fwdekker/falloutcurvetable/Main.kt renamed to src/main/kotlin/com/fwdekker/falloutcurvetables/Main.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.fwdekker.falloutcurvetable
1+
package com.fwdekker.falloutcurvetables
22

33
import com.beust.jcommander.JCommander
44
import com.beust.jcommander.Parameter

0 commit comments

Comments
 (0)