Skip to content

Commit 9335fae

Browse files
authored
Update docs (#19)
1 parent 5942780 commit 9335fae

10 files changed

+49
-21
lines changed

Quests/Publish to GitHub.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ tags:
33
- quest
44
class: Quest
55
date_created: 2025-07-27
6-
description:
6+
description: Publish the Nexus project to GitHub!
77
type: misc
8-
location:
9-
link:
10-
status: 🕯️ pending
8+
location: GitHub
9+
link: https://github.com/Fabulani/nexus
10+
status: 🏆 completed
1111
priority: 5 ⚪
1212
---
1313

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
A gamified framework for tracking projects (quests) and inventory.
44

5+
![Quest Screenshot](./Tutorial/Images/Publish-to-GitHub-quest-screenshot.png)
6+
57
## Install
68

79
The only pre-requisite is [Obsidian](https://obsidian.md/download).
@@ -30,4 +32,27 @@ And that's it! Check the `Tutorial` folder for further guidance:
3032
- inventory: insurance claims will be easier, better, and more accurate with a detailed account of possessions. Specific name, brand, color, receipts, and images are a plus. It also makes it easier to find where things are.
3133
- quests: too many ideas, projects, plans, etc. Can't keep track of them all.
3234

33-
The inventory is not designed for very short-term or consumable items, e.g., a kitchen pantry inventory.
35+
The inventory is not designed for very short-term or consumable items, e.g., a kitchen pantry inventory.
36+
37+
## Screenshots
38+
39+
![Screenshot of an Item in the Nexus](./Tutorial/Images/Item-screenshot.png)
40+
41+
Fig: an Item.
42+
43+
![Screenshot of a Container in the Nexus](./Tutorial/Images/Container-screenshot.png)
44+
45+
Fig: a Container.
46+
47+
![Screenshot of another Quest](./Tutorial/Images/Cpp-Quest-screenshot.png)
48+
49+
Fig: another Quest.
50+
51+
![The Quest Log](./Tutorial/Images/Quest-log-screenshot.png)
52+
53+
Fig: the Quest Log
54+
55+
![The Inventory visualization in graph view](./Tutorial/Images/Graph-view-screenshot.png)
56+
57+
Fig: inventory structure generates a nice graph view.
58+
3.83 KB
Loading
79.3 KB
Loading
86.7 KB
Loading
32.9 KB
Loading
94.6 KB
Loading
82.9 KB
Loading
91.5 KB
Loading

Tutorial/Usage.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,31 @@
1-
# How to use this system
1+
# Usage
22

3-
## Creating new notes
3+
Always use the colored buttons in the ribbon (left-side bar). There is a button for each task:
4+
- New Quest
5+
- New Item
6+
- New Template
7+
- and so on...
48

5-
One of these:
6-
- Click one of the colored buttons in the ribbon (left-side bar).
7-
- Use the command `QuickAdd: New <template name>` and pick one of the templates. Adjust properties in the created file.
8-
## Creating new templates
9+
![Buttons in the ribbon](./Images/Buttons-in-ribbon.png)
10+
11+
For Quests and Inventory, set fields in the front matter as you like. You can also add additional content in the note body.
12+
13+
## Graph View
14+
15+
The Inventory has been structured such that the Obsidian Graph View can automatically generate a nice hierarchical view of your inventory. Every item points upwards to its container, such that they are connected in the graph. This allows you to traverse the graph and see from a glance where everything is.
16+
17+
![Graph View inventory](./Images/Graph-view-screenshot.png)
918

10-
One of these:
11-
- Click on the `New Template` button in the ribbon.
12-
- Use the command `QuickAdd: New Template`.
1319
## Creating new classes
1420

1521
Metadata Menu, QuickAdd, and Templater are used for the class system:
1622
1. Create a note for each selector field with all possible values in `Settings/Fields`
1723
2. Create a file class in `Settings/Classes`. This represents a new type of class and defines the fields for the template.
18-
3. Use the command `QuickAdd: New Template` (or click on the button in the ribbon) to create a new template file. Wait until it prompts for adding properties, and click on the "add to end of front matter" button on the top right of the modal.
24+
3. Use the `New Template` button to create a new template file. Wait until it prompts for adding properties, and click on the `Add this field at the end of the front matter` button on the top right of the modal.
1925
4. Create a new QuickAdd template choice for creating the note.
2026

21-
## Updating a note's front matter
22-
23-
Easiest method is to click on the class icon button in the note and select "Insert missing fields in the front matter". It's at the bottom of the front matter.
24-
25-
Another method is to use the command `Metadata Menu: Bulk insert missing fields` and click on the last button, "Insert at the end of the front matter".
26-
27+
## Updating a note's front matter with new fields
2728

29+
Easiest method is to click on the class icon button in the note and select `Insert missing fields in the front matter`. It's at the bottom of the front matter.
2830

31+
Another method is to use the command `Metadata Menu: Bulk insert missing fields` and click on the last button, `Insert at the end of the front matter`.

0 commit comments

Comments
 (0)