5e-bits / 5e-bits/5e-srd-api

Add a recharge field to features and other applicable elements

Aberta
#992 0 comentários 0 reações 0 responsáveis Ver no GitHub
Linguagem predominante
TypeScript
Estrelas
637
Forks
189
Merge médio
5h 51min
PRs com merge (30d)
16

Descrição

Many abilities in the game can only be cast a certain amount of times until they are recharged. A few examples, not all are SRD compliant but there is no detailed info here :
* bardic-inspiration-1 : Charisma times per long rest
* font-of-inspiration : transforms the long rest in short rest for the bardic inspirations
* wand of magic missiles : 7 charges, 1d6+1 recharge per long rest
* ki : level times per short rest
* Druid Star Map: Guiding bolt : proficiency times per long rest
* Githzerai psionics : Either Shield or Detect through 1 times per long rest

It would be great to have a way to represent the amount of times a feature or one of its element can be used. For example on "ki":
```json
{
"index": "ki",
...
"resources": [ {
"name": "Ki Point",
"dependency": {
"name": "ki",
"url": "...."
},
"amount": "${level}",
"amount": "min(1, ${charisma})", // Example of a representation of something that could be parsed and evaluated
"recharge": "short-rest",
"recharge_amount": "full",
"action": "various"
}]
}
```

Having such a representation would help building automated resource management summaries, with checkboxes or textfield to activate or reduce the available amount of resource of a particular ability.

The current workaround would be to parse the "desc" field and hope we have guessed the right information.

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Direção de pesquisa

Look at the existing feature data structures in the repository, likely in a data directory. Understand how resources are currently represented. The issue suggests adding a 'resources' array with fields like name, dependency, amount, recharge, recharge_amount, and action. Start by examining a sample feature file (like for 'ki') to see the current schema. Determine where to add this new field and how to parse expressions like '${level}'. Check if there are existing tests for data validation.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
json, typescript
Domínio
api, data
Tipo de issue
Funcionalidade
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
50/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.