Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Looking for Work? #4

Open
7 tasks
sigrunixia opened this issue Jul 24, 2023 · 5 comments
Open
7 tasks

Looking for Work? #4

sigrunixia opened this issue Jul 24, 2023 · 5 comments
Labels
Call Reinforcements A banner is slammed into the ground, summoning allies to aid in the issue.

Comments

@sigrunixia
Copy link
Member

sigrunixia commented Jul 24, 2023

The entire Repo is in markdown format, but it needs some work getting to be a pretty and functional SRD.

If you want to volunteer, it is requested you commit to taking on an entire section.

Release 0.1.0:

Here is what needs to be looked over

  • Basic Rules and Legal
  • Divine
  • Epic
  • Magic Items
  • Monsters
  • Psionics
  • Spells

Guidelines

Folders

There are two main folders of note:

compendium/dnd3-5 is for single file entries of spells, monsters, etc. Think of it like your appendix at the end of the book that includes the pictures and statblocks

rules/dnd3-5 is for the rulebook files. How do the mechanics work? How do make a class, etc.

Naming Convention

Because so much overlaps between 3.5, 5e, and pf2e, the following naming convention is expected (but we can always.. choose something better as a suffix):

Kebab-Case-Name-Here-3-5e
Fireball-3-5e
Black-Gear-3-5e

Note, we are deliberately avoiding using a period . for filesystem compatibility.

Links

Wikilinks are ok
Links should be Absolute links
Table links should be markdown links. You will thank yourself later.

Files

Every file must have at least the following YAML:

aliases: [File Name without dashes Here] # Example: aliases: [Fireball]
tags: 3-5e/tag-nesting-here # Example: tags: 3-5e/rules/magic
@sigrunixia sigrunixia added the Call Reinforcements A banner is slammed into the ground, summoning allies to aid in the issue. label Jul 24, 2023
@sigrunixia sigrunixia pinned this issue Jul 24, 2023
@abaddon01
Copy link
Contributor

Naming Convention Because so much overlaps between 3.5, 5e, and pf2e, the following naming convention is expected (but we can always.. choose something better as a suffix): Fireball-3-5e
This seems very messy when referencing spells from other notes or inside statblocks for example. having the notes named 3.5-Spell-List, and the spells themselves as per normal still makes it obvious which edition the spell is from. [[3.5-SpellList#Fireball]]

@sigrunixia
Copy link
Member Author

Aliases take care of this, because you can use [[Fireball-3-5e|Fireball]]. We can also make Fantasy Statblocks use an alias of a linked file, so the appearance will be Fireball.

Using [[3.5-SpellList#Fireball]] is prone to breakage, as if you ever change the head name, or the file name, the link is prone to being broken due to header links not being tracked by Obsidian for link updates, consistently.

I am open to other name conventions we can use in the filename, if you have any.

@abaddon01
Copy link
Contributor

abaddon01 commented Mar 4, 2024

Aliases take care of this, because you can use [[Fireball-3-5e|Fireball]]. We can also make Fantasy Statblocks use an alias of a linked file, so the appearance will be Fireball.

Using [[3.5-SpellList#Fireball]] is prone to breakage, as if you ever change the head name, or the file name, the link is prone to being broken due to header links not being tracked by Obsidian for link updates, consistently.

I'm a little confused - my use case has all spells in a single file.
File 3.5-Spell List.md

3.5-Spell List

Fireball

  • Evocation [Fire]
  • Level: Sor/Wiz 3
  • Components: V, S, M (etc)

Flamestrike

File Fred the wizard.md

Fred the Wizard

I really like fireballs.

Spells

  • [[3.5-Spell List#Fireball|Fireball]]

I had a play around in the vault. If I renamed the spell file inside obsidian it tracked the change successfully. If I changed it outside Obsidian it failed as expected, which is fair.
I feel that a spell file with a list of spells 3.5 Acid Arrow, 3.5 Fireball, 3.5 Flamestrike, or variation thereof, is a little redundant.
I don't understand how I would links headers in other files without referencing the filename, or I may be misunderstanding how you envisage the usage. (Not a markdown expert)
I have the files I am working on in my fork - compendium branch. 3.5 Compendium Files directory
https://github.com/abaddon01/DnD-3.5-SRD-Markdown/tree/Compendium

@sigrunixia
Copy link
Member Author

Aliases take care of this, because you can use [[Fireball-3-5e|Fireball]]. We can also make Fantasy Statblocks use an alias of a linked file, so the appearance will be Fireball.
Using [[3.5-SpellList#Fireball]] is prone to breakage, as if you ever change the head name, or the file name, the link is prone to being broken due to header links not being tracked by Obsidian for link updates, consistently.

I'm a little confused - my use case has all spells in a single file. File 3.5-Spell List.md

3.5-Spell List

Fireball

  • Evocation [Fire]
  • Level: Sor/Wiz 3
  • Components: V, S, M (etc)

Flamestrike

File Fred the wizard.md

Fred the Wizard

I really like fireballs.

Spells

  • [[3.5-Spell List#Fireball|Fireball]]

I had a play around in the vault. If I renamed the spell file inside obsidian it tracked the change successfully. If I changed it outside Obsidian it failed as expected, which is fair. I feel that a spell file with a list of spells 3.5 Acid Arrow, 3.5 Fireball, 3.5 Flamestrike, or variation thereof, is a little redundant. I don't understand how I would links headers in other files without referencing the filename, or I may be misunderstanding how you envisage the usage. (Not a markdown expert) I have the files I am working on in my fork - compendium branch. 3.5 Compendium Files directory abaddon01/DnD-3.5-SRD-Markdown@Compendium

After thinking on this, a lot, I think we can go with your idea. It will be easy enough for a user to change after the fact. A recent Obsidian update does make [[##]] linking better.

@PhoenixWorkshops
Copy link

I'd like to help with the conversion, if you are still looking for aid. If so, where would you like me to add some support efforts?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Call Reinforcements A banner is slammed into the ground, summoning allies to aid in the issue.
Projects
None yet
Development

No branches or pull requests

3 participants