daid / daid/EmptyEpsilon

[scriptdocs] Path references are incorrect

Open
#1,962 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lua
Stars
869
Forks
222
Avg merge
18h 33m
Merged PRs (30d)
1

Description

@daid via Discord:

Audio can be in /scripts/audio/ as well. Nothing is special about /resources/ or scripts, both paths get searched.

Yes, resources, then scripts then packs. The order in which resource providers get build in main.cpp

Remove or correct scripting docs references to specific paths that suggest either resources/ or scripts/, which are incorrect.

Document the full traversal order in the wiki for reference:

if mod=something, then ~/.emptyepsilon/resources/mods first if $HOME is defined, then packs in ~/.emptyepsilon/resources/mods, then resources/mods, then packs in resources/mods, then resources/, then scripts/, then packs/, then if $HOME is defined then ~/.emptyepsilon/resources, then ~/.emptyepsilon/scripts, then packs in ~/.emptyepsilon/packs, and then if there's a RESOURCE_BASE_DIR defined then resources and scripts and packs in there

then EE checks that same list, in the same order, for a corresponding locale subdirectory for the main .po files

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the scripting documentation for references that imply resources/ or scripts/ are special, then compare them with the traversal order described in the issue. Correct those references and document the full traversal order, including locale lookup, in the wiki; the work is done when both the scripting docs and wiki match the stated order.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.