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

Guide Book Functionality #4009

Open
AlexIIL opened this issue Jan 30, 2018 · 5 comments

Comments

Projects
None yet
2 participants
@AlexIIL
Copy link
Member

commented Jan 30, 2018

The guide book is useful as-is, but a lot of things still need to be implemented in order to make it more useful.

Required functionality:

  • (no-issue-yet) Allow for linking to different groups inside of a single page.
  • (no-issue-yet) Export entire book into a web page. This will allow us to create a fully up-to-date guide, outside of the main game, without needing to maintain two separate sources.

Optional additions:

  • (no-issue-yet) Other font renderers (for example a cleartext native font, rather than the current pixelated minecraft font). While native font render mods exist it would be useful to have a version that works just for the guide book.

This issue is intended to be an umbrella of a lot of smaller issues. If any progress is made on a smaller feature (or some-one has comments on a specific point of functionality, or wishes to help implement a smaller feature) then it should be commented on the related issue.

@LordGolias

This comment has been minimized.

Copy link
Collaborator

commented Apr 15, 2018

Regarding the export to a web page. Does BC host a web host that we can output the result on?

We can certainly export it to html, but it would probably make more sense to think of this guide book as "documentation" in the sense that it is attached to a particular version of BC. If that is the case, then we need to think about a way to automatize this. I suspect that you have a pipeline for releasing a new version. How hard is it to have an extra step to build and publish the "documentation" aka guide book on the web host?

@AlexIIL

This comment has been minimized.

Copy link
Member Author

commented Apr 15, 2018

Exporting:

  • I currently host the website from nginx (https://www.mod-buildcraft.com/), so customisation should be possible.
  • Every time I release a new version (compile + push the jars to the website) I just run some script files that auto-sync the content to the webserver. Adding an additional script and calling it from the main one would be the trivial part, actually exporting the content would be the hard bit.
@AlexIIL

This comment has been minimized.

Copy link
Member Author

commented Apr 15, 2018

Oh, and I also plan to move the source for these scripts (and the rest of the backing code, like the markdown files for each blog post and page) to a github repo, so that it's easier to manage (and request help from others). The actual built JAR files won't go up as it's about 1.3 GB in total.

LordGolias added a commit to LordGolias/BuildCraft that referenced this issue Apr 15, 2018

@LordGolias

This comment has been minimized.

Copy link
Collaborator

commented Apr 15, 2018

I did a small iteration on this, as a prototype. Essentially, implemented the md -> html conversion in Python. If you run it, it will generate a bunch of static html from the md files. It is not on the build steps as I am not very familiar with gradle, and there is no CSS because it depends on the particular CSS of the website.

The recipes are not working yet.

@AlexIIL

This comment has been minimized.

Copy link
Member Author

commented Apr 15, 2018

Just FYI guide page exporting isn't a very high priority right now, as there's still functionality missing. In addition it will need some Java code to export recipes, and item icons, so I was planning on writing it all in Java. (It's normally fairly simple to run java code from a script, although I suppose it's platform dependant as bash files cannot be run from windows).

Essentially feel free to continue with this, but I can't guarantee it will be useful :(

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.