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

kdl-unofficial-template:0.1.0 #1787

Merged
merged 4 commits into from
Mar 7, 2025

Conversation

epsilonhalbe
Copy link
Contributor

I am submitting

  • a new package
  • an update for a package

This is a TTRPG scenario template for the horror roleplaying game "KULT: divinity lost" - the scenarios themselves have to be released under the conditions for fan made scenarios.

The package/template gives scaffolding for writing full scenarios in a printer and non-printer friendly version including character sheets, title pages, chapters, i.e. everything I could think of.

I have read and followed the submission guidelines and, in particular, I

  • selected a name that isn't the most obvious or canonical name for what the package does

  • added a typst.toml file with all required keys

  • added a README.md with documentation for my package

  • have chosen a license and added a LICENSE file or linked one in my README.md

  • tested my package locally on my system and it worked

  • excluded PDFs or README images, if any, but not the LICENSE

  • ensured that my package is licensed such that users can use and distribute the contents of its template directory without restriction, after modifying them through normal use.

Hey this is my first template/package I've tried to do my best to test it, but I'd appreciate someone else trying as well.
All the best
Martin

@typst-package-check typst-package-check bot added the new A new package submission. label Feb 20, 2025
@epsilonhalbe
Copy link
Contributor Author

checking rn what is going on - was developing this with 0.12 and things worked well
updating typst to 0.13 now and testing

@epsilonhalbe
Copy link
Contributor Author

the error I am seeing is from cetz @preview/cetz:0.3.2/src/canvas.typ:124:8 - I fixed all errors in my own sources

@elegaanz
Copy link
Member

If you are not in a hurry, I would like to wait for a new version of cetz to be released with a fix for that, so that you can publish your package without any warning. If you prefer we can also merge right now, but then it would be nice if you could publish another version to update cetz once possible.

@epsilonhalbe
Copy link
Contributor Author

I've been sitting on this for a few months - so a little bit extra waiting time is no big deal, I've had a look at the CeTZ PR fixing this issue, but I am missing too much context to make a meaningful contribution reviewing that one.

@epsilonhalbe
Copy link
Contributor Author

the issue has been fixed on CeTZ side, but the release of it is in 0.4.0 - which is hopefully happening in the near future. in the mean time could someone check if the package meets the best practises, so I fix stuff while waiting for the 0.4.0 release of CeTZ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Font files should not be committed to this repository. You should add instructions in your README or in the template on how to install and use them with Typst instead.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it allowed to distribute content using this logo?

license = "MIT"
entrypoint = "lib/lib.typ"
description = "An unofficial template for community scenarios for the TTRPG 'KULT: divinity lost'"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As reported by the CI, you should include at least one category for your package.

license = "MIT"
entrypoint = "lib/lib.typ"
description = "An unofficial template for community scenarios for the TTRPG 'KULT: divinity lost'"
category = "book"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Categories should always be a list, even if there is a single one.

Suggested change
category = "book"
categories = ["book"]

@epsilonhalbe epsilonhalbe force-pushed the kdl-unofficial-template branch from d2466b4 to a44bdc3 Compare March 7, 2025 09:33
@elegaanz
Copy link
Member

elegaanz commented Mar 7, 2025

Thank you :)

@elegaanz elegaanz merged commit 20703a2 into typst:main Mar 7, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new A new package submission.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants