Skip to content

Commit 5a87f3c

Browse files
committed
finished template setup
1 parent 7a66729 commit 5a87f3c

File tree

67 files changed

+2510
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+2510
-0
lines changed

.copier-answers.hexdoc-hexcasting.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Changes here will be overwritten by Copier. NEVER EDIT MANUALLY
2+
# See: https://copier.readthedocs.io/en/stable/configuring/#the-copier-answersyml-file
3+
_commit: v0.1.11
4+
_src_path: gh:hexdoc-dev/hexdoc-hexcasting-template
5+
author: Kandiyaki
6+
book_id: hex_chalkcircles:hex_chalkcirclesbook
7+
default_branch: main
8+
github_repo: hex_chalkcircles
9+
gradle_mod_version_key: modVersion
10+
hexdoc_mod_plugin_classname: Hex_chalkcirclesModPlugin
11+
hexdoc_plugin_classname: Hex_chalkcirclesPlugin
12+
java_lang:
13+
ext: java
14+
src: java
15+
java_package: net/hex_chalkcircles
16+
mod_display_name: Hex Circles
17+
modid: hex_chalkcircles
18+
multiloader: true
19+
package_export_root: doc/src/hexdoc_hex_chalkcircles/_export
20+
package_name: hexdoc-hex-chalkcircles
21+
package_slug: hexdoc_hex_chalkcircles
22+
package_src: doc/src/hexdoc_hex_chalkcircles
23+
pages_url: https://kandiyaki.github.io/hex_chalkcircles
24+
pattern_regex:
25+
per_world_value: registerPerWorld
26+
regex: (?P<is_per_world>register|registerPerWorld)\(HexPattern\.fromAngles\("(?P<signature>[qweasd]+)",\s*HexDir\.(?P<startdir>\w+)\),\s*"(?P<name>[^"]+)"?
27+
pattern_registry: registry/Hex_chalkcirclesPatternRegistry.java

.copier-answers.hexdummy.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
2+
# https://copier.readthedocs.io/en/stable/configuring/#the-copier-answersyml-file
3+
_commit: v0.0.9
4+
_src_path: gh:FallingColors/hexdummy
5+
author: Kandiyaki
6+
capitalize_platforms: false
7+
classname: Hex_chalkcircles
8+
default_branch: main
9+
description: Hex Casting addon for single-use spell circles
10+
display_name: Hex Circles
11+
github_repo: hex_chalkcircles
12+
hexcasting_version: 0.10.3
13+
homepage_url: https://kandiyaki.github.io/hex_chalkcircles
14+
initial_mod_version: 0.0.1
15+
java_version: 17
16+
license: MIT
17+
mappings_name: Mojmap
18+
modid: hex_chalkcircles
19+
package: net.hex_chalkcircles
20+
sources_url: https://github.com/Kandiyaki/hex_chalkcircles

.github/workflows/build_docs.yml

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
name: Build the web book
2+
3+
on:
4+
push:
5+
branches: main
6+
tags: "v*"
7+
workflow_dispatch:
8+
inputs:
9+
release:
10+
description: Release this version
11+
type: boolean
12+
default: false
13+
publish:
14+
description: Package index to publish to
15+
type: choice
16+
options:
17+
- none
18+
- PyPI
19+
# - TestPyPI
20+
21+
env:
22+
PYPI_PACKAGE: hexdoc-hex-chalkcircles
23+
24+
permissions:
25+
contents: read
26+
27+
jobs:
28+
hexdoc:
29+
uses: hexdoc-dev/hexdoc/.github/workflows/hexdoc.yml@v1!0.1.dev
30+
permissions:
31+
contents: write
32+
pages: read
33+
secrets:
34+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
35+
with:
36+
python-version: '3.11'
37+
release: |-
38+
${{
39+
github.event_name != 'push' && inputs.release
40+
|| github.event_name == 'push' && startsWith(github.event.head_commit.message, '[Release]')
41+
|| github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
42+
}}
43+
44+
publish-pypi:
45+
runs-on: ubuntu-latest
46+
needs: hexdoc
47+
if: |-
48+
needs.hexdoc.outputs.release == 'true' &&
49+
(github.event_name == 'push' || inputs.publish == 'PyPI')
50+
environment:
51+
name: pypi
52+
url: https://pypi.org/p/${{ env.PYPI_PACKAGE }}
53+
permissions:
54+
id-token: write
55+
steps:
56+
- name: Download package artifact
57+
uses: actions/download-artifact@v3
58+
with:
59+
name: hexdoc-build
60+
path: dist
61+
62+
- name: Publish to PyPI
63+
uses: pypa/gh-action-pypi-publish@release/v1
64+
65+
# Uncomment if you want to try publishing to TestPyPI before using the real index.
66+
67+
# publish-testpypi:
68+
# runs-on: ubuntu-latest
69+
# needs: hexdoc
70+
# if: github.event_name != 'push' && inputs.publish == 'TestPyPI'
71+
# environment:
72+
# name: testpypi
73+
# url: https://test.pypi.org/p/${{ env.PYPI_PACKAGE }}
74+
# permissions:
75+
# id-token: write
76+
# steps:
77+
# - name: Download package artifact
78+
# uses: actions/download-artifact@v3
79+
# with:
80+
# name: hexdoc-build
81+
# path: dist
82+
83+
# - name: Publish to TestPyPI
84+
# uses: pypa/gh-action-pypi-publish@release/v1
85+
# with:
86+
# repository-url: https://test.pypi.org/legacy/

.gitignore

Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,187 @@
1+
build/
2+
*.ipr
3+
run/
4+
*.iws
5+
out/
6+
*.iml
7+
.gradle/
8+
output/
9+
bin/
10+
libs/
11+
12+
.classpath
13+
.project
14+
.idea/
15+
classes/
16+
.metadata
17+
.settings
18+
*.launch
19+
.DS_Store
20+
21+
venv
22+
23+
.architectury-transformer
24+
25+
# hexdoc
26+
_site/
27+
_checkout/
28+
__gradle_version__.py
29+
.hexdoc*/
30+
31+
.hexdoc-template-inputs.yml
32+
33+
# Python
34+
35+
# Byte-compiled / optimized / DLL files
36+
__pycache__/
37+
*.py[cod]
38+
*$py.class
39+
40+
# C extensions
41+
*.so
42+
43+
# Distribution / packaging
44+
.Python
45+
build/
46+
develop-eggs/
47+
dist/
48+
downloads/
49+
eggs/
50+
.eggs/
51+
lib/
52+
lib64/
53+
parts/
54+
sdist/
55+
var/
56+
wheels/
57+
share/python-wheels/
58+
*.egg-info/
59+
.installed.cfg
60+
*.egg
61+
MANIFEST
62+
63+
# PyInstaller
64+
# Usually these files are written by a python script from a template
65+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
66+
*.manifest
67+
*.spec
68+
69+
# Installer logs
70+
pip-log.txt
71+
pip-delete-this-directory.txt
72+
73+
# Unit test / coverage reports
74+
htmlcov/
75+
.tox/
76+
.nox/
77+
.coverage
78+
.coverage.*
79+
.cache
80+
nosetests.xml
81+
coverage.xml
82+
*.cover
83+
*.py,cover
84+
.hypothesis/
85+
.pytest_cache/
86+
cover/
87+
88+
# Translations
89+
*.mo
90+
*.pot
91+
92+
# Django stuff:
93+
*.log
94+
local_settings.py
95+
db.sqlite3
96+
db.sqlite3-journal
97+
98+
# Flask stuff:
99+
instance/
100+
.webassets-cache
101+
102+
# Scrapy stuff:
103+
.scrapy
104+
105+
# Sphinx documentation
106+
docs/_build/
107+
108+
# PyBuilder
109+
.pybuilder/
110+
target/
111+
112+
# Jupyter Notebook
113+
.ipynb_checkpoints
114+
115+
# IPython
116+
profile_default/
117+
ipython_config.py
118+
119+
# pyenv
120+
# For a library or package, you might want to ignore these files since the code is
121+
# intended to run in multiple environments; otherwise, check them in:
122+
# .python-version
123+
124+
# pipenv
125+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
126+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
127+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
128+
# install all needed dependencies.
129+
#Pipfile.lock
130+
131+
# poetry
132+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
133+
# This is especially recommended for binary packages to ensure reproducibility, and is more
134+
# commonly ignored for libraries.
135+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
136+
#poetry.lock
137+
138+
# pdm
139+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
140+
#pdm.lock
141+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
142+
# in version control.
143+
# https://pdm.fming.dev/#use-with-ide
144+
.pdm.toml
145+
146+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
147+
__pypackages__/
148+
149+
# Celery stuff
150+
celerybeat-schedule
151+
celerybeat.pid
152+
153+
# SageMath parsed files
154+
*.sage.py
155+
156+
# Environments
157+
.env
158+
.venv
159+
env/
160+
venv/
161+
ENV/
162+
env.bak/
163+
venv.bak/
164+
165+
# Spyder project settings
166+
.spyderproject
167+
.spyproject
168+
169+
# Rope project settings
170+
.ropeproject
171+
172+
# mkdocs documentation
173+
/site
174+
175+
# mypy
176+
.mypy_cache/
177+
.dmypy.json
178+
dmypy.json
179+
180+
# Pyre type checker
181+
.pyre/
182+
183+
# pytype static type analyzer
184+
.pytype/
185+
186+
# Cython debug symbols
187+
cython_debug/

.vscode/extensions.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
// List of extensions which should be recommended for users of this workspace.
3+
"recommendations": [
4+
"ms-python.vscode-pylance",
5+
"charliermarsh.ruff",
6+
"samuelcolvin.jinjahtml",
7+
"noxiz.jinja-snippets",
8+
],
9+
}

.vscode/settings.json

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"[python]": {
3+
"editor.defaultFormatter": "charliermarsh.ruff",
4+
"editor.formatOnSave": true,
5+
"editor.codeActionsOnSave": {
6+
"source.organizeImports.ruff": true,
7+
},
8+
"editor.rulers": [88],
9+
},
10+
"[yaml][html][css][javascript][jinja-html][jinja-css][jinja-js]": {
11+
"editor.tabSize": 2,
12+
},
13+
"[html][jinja-html]": {
14+
"editor.rulers": [120],
15+
},
16+
"ruff.organizeImports": true,
17+
"ruff.lint.args": [
18+
"--extend-ignore=I", // format on save is enabled, so don't show the squiggles
19+
],
20+
"python.languageServer": "Pylance",
21+
"python.analysis.diagnosticMode": "workspace",
22+
"python.analysis.packageIndexDepths": [
23+
{"name": "hexdoc", "depth": 3},
24+
{"name": "pydantic", "depth": 2},
25+
],
26+
"python.testing.unittestEnabled": false,
27+
"python.testing.pytestEnabled": true,
28+
"files.associations": {
29+
"*.js.jinja": "javascript",
30+
"*.css.jinja": "css",
31+
"*.jcss.jinja": "jinja-css", // for files with a lot of jinja stuff, where the linting isn't useful
32+
"*.json5.jinja": "json5",
33+
},
34+
}

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Changelog
2+
3+
##
4+
5+
- Initial version.

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Hex Circles
2+
3+
Hex Casting addon for single-use spell circles

0 commit comments

Comments
 (0)