https://github.com/sophfee/fluxlib

A mod for Atlyss that opens up the game to modders to create new content, such as items, and quests.
https://github.com/sophfee/fluxlib

atlyss atlyss-mod unity

Last synced: 6 days ago
JSON representation

A mod for Atlyss that opens up the game to modders to create new content, such as items, and quests.

• Host: GitHub
• URL: https://github.com/sophfee/fluxlib
• Owner: sophfee
• License: mit
• Created: 2024-12-17T03:52:20.000Z (21 days ago)
• Default Branch: main
• Last Pushed: 2024-12-17T04:25:40.000Z (21 days ago)
• Last Synced: 2024-12-17T05:19:09.572Z (21 days ago)
• Topics: atlyss, atlyss-mod, unity
• Language: C#
• Homepage:
• Size: 371 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# FluxLib

A mod for [Atlyss](https://store.steampowered.com/app/2768430/ATLYSS/) that aims to provide easy to digest methods to create custom content for mod creators.

## Installation

- Install [Atlyss](https://store.steampowered.com/app/2768430/ATLYSS/)

- Install [BepInEx 5.4](https://github.com/BepInEx/BepInEx/releases/tag/v5.4.23.2)

- Install [FluxLib](https://github.com/sophfee/FluxLib/releases)

- Launch the game.

## What can this mod do?

With the current version of FluxLib, you can...

- [x] Create custom trade items.

- [x] Add custom items to vendors.

- [ ] Create custom consumables.

- [ ] Create custom conditions.

- [ ] Create custom quests, with custom quest requirements.

- [ ] Append existing loot tables, to make custom items droppable from existing creeps.

More goals will be added to this list, but this is what I am currently aiming to achieve! 

## How can I use this mod?

It's fairly simple, and everything is built around the JSON file format. Upon launching the mod once, you will have a new folder in your Atlyss directory called `Flux`. Inside this folder, you will find several directories, these directories are used to load custom objects into the game, subfolders will be read when parsing.  

The `Assets` subfolder is used to load custom textures into the game, there is no current support for mesh loading, but I will work on it in the near future! The system will most likely depend on [AssetBundles](https://docs.unity3d.com/Manual/AssetBundlesIntro.html) to load custom meshes into the game.  

The `Examples` folder in this repository contains examples of how to create custom items, this will be more thoroughly documented in the future.