Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mpewsey authored Aug 9, 2024
1 parent de424a4 commit 9ec572c
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
# Sturdy Path

Sturdy Path is a Godot .NET addon that provides a way to reference a scene or resource by path, in a manner that won't break when moving files around within the project. This is accomplished by keeping track of the target file's `uid://` path, which is invariant of the file's location within the project.
[![Tests](https://github.com/mpewsey/SturdyPath/actions/workflows/tests.yml/badge.svg)](https://github.com/mpewsey/SturdyPath/actions/workflows/tests.yml)
[![Docs](https://github.com/mpewsey/SturdyPath/actions/workflows/docs.yml/badge.svg?event=push)](https://github.com/mpewsey/SturdyPath/actions/workflows/docs.yml)
![Godot .NET 4.0](https://img.shields.io/badge/Godot%20.NET-4.2-blue)
![Version](https://img.shields.io/github/v/tag/mpewsey/SturdyPath?label=Version)

Sturdy Path is a simple Godot addon that provides a way to reference a scene or resource by path, in a manner that won't break when moving files around within the project. This is accomplished by keeping track of the target file's `uid://` path, which is invariant of the file's location within the project.

![image](https://github.com/user-attachments/assets/5efec515-aa99-4f41-a93e-d01a8d8e5a43)

## Installation

1. Copy the `addons/mpewsey.sturdypath` directory from this repository into the `addons` folder of your Godot project.
2. Build your Godot project solution, so that the newly incorporated C# addon scripts are compiled.
3. Enable the addon by going to `Project > Project Settings` and clicking the enable checkbox next to the plugin.

## Example Usage

```BattleEffect.cs
Expand Down

0 comments on commit 9ec572c

Please sign in to comment.