inkle / inkle/inky

Feature: set base path for INCLUDEs

Open
#501 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
JavaScript
Stars
2.7k
Forks
340
PR merge metrics
No merged PRs in 30d

Description

In the Unity integration for Ink, our current project is taking advantage of runtime compilation to expose content for modding in the StreamingAssets folder. This means that content will live dynamically in a series of folders under our StreamingAssets/Mods directory.
We also use a bunch of external functions to interact with game state, which currently are housed in a Globals.ink file that lives in StreamingAssets/Content. Anyways, in order to make INCLUDEs work from a mod folder to the Globals.ink file, we've set the base folder path in the Ink compiler in the Unity integration to the StreamingAssets/Content folder, and now any Ink file in our project can access Globals.ink or whatever else lives in that folder.
The problem is: there is no way to set the base folder path in Inky. So as mod content is generated, nothing can be tested in the editor, because Inky assumes a relative file path. I think the simplest solution to this problem would be to expose a setting allowing a user the option to arbitrarily set the base folder path for INCLUDEs.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating Inky’s INCLUDE path resolution and editor compilation entry point; the issue does not name a file or test. Compare this with the Unity integration’s base-folder behavior, then verify that an arbitrary base path can be configured and used when resolving INCLUDEs.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
desktop, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.