EverestAPI/Everest

Add/Finalize/Document support for Lua Mods

Open

#309 opened on Jun 7, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C# (104 forks)auto 404
help wanted

Repository metrics

Stars
 (503 stars)
PR merge metrics
 (PR metrics pending)

Description

Everest has some support for mods written in Lua (Everest.LuaLoader.cs), notably used by the Lua Cutscenes Mod, but there is no documentation on how to use it, and it is unknown how much of it currently works.

Contributor guide

Research direction
Investigate the current state of Lua mod support in Everest.LuaLoader.cs, identify working and broken features, and write documentation covering how to create Lua mods.
Tech stack
csharplua
Domain
apideveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitC#Lua
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50