Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 2.02 KB

README.adoc

File metadata and controls

37 lines (22 loc) · 2.02 KB

FicsIt-Networks-Repository

This is a repository/collection of software packages for use with the FicsIt-Networks Satisfactory mod.

It contains templates, full-fledged programs and examples provided by the mod’s authors and the mod’s community.

Publish a Package

Anyone with a GitHub account can publish a package.

Create fork of this git repository and add a folder with an alphanumeric name ([a-zA-Z0-9_\-]+) to the Repository folder.

In this newly created folder create a README.adoc or README.md containing a description of your package.
Add a EEPROM.lua file containing your EEPROM Code.
Lastly, create a metadata.toml file, containing further metadata about your package.

Tip
You can look at already submitted packages for examples of package structure or check the package definition (WIP).
Note
Alternatively you can copy the Example Package, change the folder and fill in the files with your own data.

After you have comitted your changes to your fork, you can create a pull-request to this repository on the main branch.
Once your PR gets merged, your package will be available in the FicsIt-Repository.

If you want to update your software, create a copy of your package folder contents, and put them into a newly created folder inside your package folder with the version "old" version-number prefixed with v as folder name.
e.g. if you had a package MyPackage with the version 1.2.3, create a folder called v1.2.3 and copy your contents in there.
After that you can alter your package however you want.

Caution
Ensure you have increased your version number in the metadata file.

Work-In-Progress

This repository is work-in-progress.
And package definition may change over time.

Already submitted packages will get converted to new defintions using manual or automatic migration procedures if possible.

There will be web and in-game interfaces to browse the repository in more user-friendly way.