Skip to content

LunaForge is an ImGui editor for all main branches of LuaSTG. Currently in early alpha.

License

Notifications You must be signed in to change notification settings

RulHolos/LunaForge

Repository files navigation

Contributors Forks Stargazers Issues project_license


LunaForge

LunaForge is a code editor and generator targeting the LuaSTG engine (all main branches).
Explore the docs

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

The goal of LunaForge is to be a kind of "all-in-one" editor: It can compile plain lua script, compile nodes to lua, and shaders.
There is more to come~

(back to top)

Built With

.Net C# ImGUI Raylib

(back to top)

Getting Started

Section in progress...

Differences with Sharp X

The main "why" point with LunaForge is "Sharp X already exists, so why?"

  • LunaForge uses a folder-based approach for projects instead of a single-file based approach.
  • LunaForge uses ImGui instead of WPF.
  • LunaForge allows you to set an entry point for your project, making it easier to structure your project.
  • Projects are sharable by defaullt since all files are relative to the root of the project.
  • LunaForge is meant to be cross-platform for Windows, Mac and Linux. (not the case yet)

Prerequisites

Section in progress...

Installation

Section in progress...

(back to top)

Usage

Section in progress...

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Lua generated nodes
  • File Architecture
  • UI
  • UI customization
  • Node view
  • Script view
  • Shader view
  • Node cache
  • Building projects
    • Get Project files
    • Gather compile info
    • Check for checksum to avoid rebuilding the same file (if it exists in temp)
    • Create editor_output.lua and append every file
    • Run LuaSTG and link to debug info window
  • Plugin system
  • Logging

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Top contributors:

contrib.rocks image

License

All files from the LunaForge.GUI.ImGuiFileDialog namespace are taken and modified from Dalamud.

Distributed under the MIT license. See LICENSE.txt for more information.

(back to top)

Contact

Rül Hölos - @RulHolos - rulholos@protonmail.com

Project Link: https://github.com/RulHolos/LunaForge

(back to top)

Acknowledgments

(back to top)

About

LunaForge is an ImGui editor for all main branches of LuaSTG. Currently in early alpha.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published