AcrosstheObelisk.Mod.Packer 1.0.1

AcrosstheObelisk.Mod.Packer v1.0.1

A library that helps you generate Across the Obelisk mods in a standardized and mod-manager–friendly format.

It automates the creation of the final distribution package, ensuring that your mod is packaged correctly and consistently.

Why use this?

AcrosstheObelisk.Mod.Packer removes the friction from packaging your mod so you can focus on development instead of maintenance.

Key benefits:

• Zero-effort packaging: Quickly generate a complete, ready-to-distribute mod package with a single execution.
• Automatic version management: The tool ensures that version updates are consistently applied to both README.md and manifest.json, eliminating manual synchronization errors.
• Seamless DLL inclusion: Your compiled mod DLL is automatically copied into the final package, removing the need for manual file management.
• Fast development iteration: Simply make your changes, run the packer, and test your mod. No repetitive setup, no forgotten files.

Overall, this tool streamlines the entire packaging workflow, making mod development faster, safer, and more enjoyable.

Installation

The tool can be installed via NuGet Package Manager.

Package name: AcrosstheObelisk.Mod.Packer

Usage

The library provides a Packer component, which is responsible for generating the final package (.zip) file.

The generated package may include:

• Your mod manifest
• README
• CHANGELOG
• Icon
• Compiled mod DLL
• Any other Obeliskial_importing resources

You simply need to integrate it into your own console application. When executed, the application will pack your mod automatically.

Example

using AcrossTheObelisk.Mod.Packer;

var baseDir = AppContext.BaseDirectory;
var sourceDir = Path.Combine(baseDir, "../../..");

var packer = new Packer();
packer.Pack(new PackerContext(
    otherResources: $"{baseDir}/FakeResources",
    distributionPath: $"{baseDir}/Dist",
    readmePath: $"{sourceDir}/README.md",
    changelogPath: $"{baseDir}/CHANGELOG.md",
    modDllPath: $"{baseDir}/FakeDll/mod-fake.dll",
    version: new PackVersion(
        modIdentifier: "fake-id",
        modName: "fake-mod-name",
        websiteUrl: "https://fake-website.stub",
        description: "just a fake description",
        author: "myself",
        semanticVersion: "1.0.1",
        lastUpdateDate: 20252112,
        dependencies: new List<string>()
        {
            "dependency-1",
            "dependency-2"
        }
    )
));

Samples

The following repositories currently use this tool and can be consulted for additional examples:

• TheChosenOnes
• Playground Test

History

The change log can be found here.

License

The MIT License (MIT)

Copyright (c) 2015 Chris Kibble

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.