darkatra / bfme2-modding-utils

A library that provides functions to read and write some of the EA file formats.

Hi there 👋

I'm a software developer who mostly works with web technologies, but I also modify old video games from my childhood from time to time. I recently started writing about it in my blog: https://darkatra.dev/

bfme2-modding-utils's Issues

Reader for BIG Files

Finish Map File Format Reader

TODO:

• PolygonTriggers
• TriggerAreas
• GlobalWaterSettings
• FogSettings
• MissionHotSpots
• MissionObjectives
• StandingWaterAreas
• RiverAreas
• StandingWaveAreas
• GlobalLighting
• PostEffectsChunk
• EnvironmentData
• NamedCameras
• CameraAnimationList
• CastleTemplates
• WaypointsList
• SkyboxSettings

Make sure to use unsigned numbers where needed

Currently unsigned datatypes are still experimental in kotlin 1.4: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-experimental-unsigned-types/

Choices:

• wait for unsigned datatypes to become stable
• enable the experimental feature and use them

RefpackInputStream sometimes results in wrong output

Reading a map file results in differing outputs when using this libs RefpackInputStream and the one provided by the OpenSage Team. This prob. means that the current RefpackInputStream implementation is broken 🙈

Test the MapFileReader

The plan is to write tests that read a set of maps and compare certain properties to values pulled from WorldBuilder.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update all non-major dependencies to v2.0.20 (org.jetbrains.kotlin:kotlin-maven-plugin, org.jetbrains.kotlin:kotlin-test, org.jetbrains.kotlin:kotlin-reflect, org.jetbrains.kotlin:kotlin-stdlib-jdk8)

Detected dependencies

github-actions

.github/workflows/build.yml

• actions/checkout v4
• actions/setup-java v4
• cycjimmy/semantic-release-action v3

.github/workflows/pull-request-lint.yml

• amannn/action-semantic-pull-request v5.5.3

.github/workflows/pull-request.yml

• actions/checkout v4
• actions/setup-java v4

maven

big/pom.xml

core/pom.xml

map/pom.xml

pom.xml

• org.jetbrains.kotlin:kotlin-stdlib-jdk8 2.0.10
• org.jetbrains.kotlin:kotlin-reflect 2.0.10
• org.jetbrains.kotlin:kotlin-test 2.0.10
• com.google.guava:guava 33.3.0-jre
• org.junit:junit-bom 5.11.0
• org.assertj:assertj-core 3.26.3
• org.jetbrains.kotlin:kotlin-maven-plugin 2.0.10
• org.apache.maven.plugins:maven-source-plugin 3.3.1
• org.apache.maven.plugins:maven-surefire-plugin 3.4.0

refpack/pom.xml

---

• Check this box to trigger a request for Renovate to run again on this repository

Writer for MapFiles

TODO:

• implement methods to calculate the byte counts for each serializer
• implement @Asset specific serialization steps (writing the asset header and building the map of assetName <-> assetIndex)
• implement methods to serialize the actual data
• implement the MapFileWriter with optional compressions for EAR and ZL5 -> only ZL5 is supported for now