Giter VIP home page Giter VIP logo

abiotic-factor-tools's Introduction

Abiotic Factor Tools

This monorepo implements tools to process Abiotic Factor game files, mostly used to manage the Abiotic Factor Wiki

Requirements

Versions below are known to be working, but other versions might be compatible.

  • Python 3.10.12
  • pipx 1.0.0
  • Poetry 1.8.3
  • Node 21.7.3
  • pnpm 8.7.0

Usage

  • Install project using pnpm i
  • Create your .env following the .env.example file
  • Build projects using npx nx run-many -t build --all

Extracting content from the game

Use FModel to extract content from the game. In a single root folder, extract Blueprints and StringTables as JSON, and Textures as PNG.

Exporting JSON files from extracted ones

Run npx nx run data-exporter:serve. This process is can be stopped once the files are exported

Update th wiki

Run npx nx run wiki-updater:run. Follow the credential instructions from mwcleric.

Development

This repository is a Nx monorepo. Read their documentation and use the Nx Console vscode extension to have a better experience.

Individual projects are found in the /projects folder, being described in the following sections.

data-exporter

This Node application read raw game files to output parsed JSON and images. The RAW game files should be extracted using FModel.

wiki-updater

This Python application pushes updates to the Wiki, using the parsed JSON files from data-exporter.

abiotic-factor-tools's People

Contributors

julioc avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.