timwi / ktanecontent

Contains all the content hosted on https://ktane.timwi.de, including all manuals and their fonts and graphics files, the Logfile Analyzer, the Highlighter, the Profile Editor, the Mode Settings Editor. The server-side code is at https://github.com/Timwi/KtaneWeb.

KTANE Content

This repository contains the files that are hosted on https://ktane.timwi.de/. It does not contain the software that runs the server; this is hosted in https://github.com/Timwi/KtaneWeb.

The various folders in this repository are:

HTML, PDF

Contains HTML and PDF versions of all the KTANE module manuals and cheat sheets.

HTML/img

Contains image files used both by the manuals as well as the website proper. The component SVGs (the graphics in the top-right corner of every manual) are stored in HTML/img/Component. All other graphics for a specific manual are stored in a subfolder by the module’s name. The graphics directly in HTML/img are either shared by all manuals (e.g. the background images) or used by the website.

HTML/js

Contains the JavaScript used by the manuals that enables the highlighting features, as well as external libraries such as jQuery UI.

JSON

Contains JSON files about each module's various pieces of information such as: name, description, source code, release date, steam workshop ID, etc.

Icons

Contains the module icons. Each icon should be 32×32 pixels, use alpha transparency, and preferably be minimalized using pngcrush.

This folder does not contain other UI icons used on the website. Those are in HTML/img.

puzzles

Contains the files of the puzzles made by the community.

More

Contains the Logfile Analyzer, Profile Editor, Template Manual and a few other files.

ktanecontent's Issues

New JSON information and a Display request

This request is a combination of three different requests:

• Change the "author" field to have separate options for Maintainer and TP Implementer/Maintainer. At the bare minimum it should list the person who has access to the workshop entry and the person who is in charge of TP bugs, as they're the most common to report to. If necessary, we can also have an optional Script implementer field, if the person who coded the module is different than who uploaded it, and a Manual implementer field, if the uploader does not handle altering the manual.

• Update: This request may also address a way to contact said authors, however that might need to be handled separately.

• Allow the option to separate manuals for translated modules from translated manuals for english modules. Timwi has given me a suggestion for this that looks as such: (Note; to see these images, you'll need to copy the urls into a discord message as Discord released an update that prevents images from loading outside of the client without a temporary key.)
  https://cdn.discordapp.com/attachments/391425387231576065/694252390789939210/unknown.png
  Another suggestion added November 4th for the Source/Steam urls:
  https://cdn.discordapp.com/attachments/640557658482540564/773714167546773504/unknown.png

"Adding a option to Option > Display to display symbols, promoting symbols usage"

• Fang
  This will allow symbols to appear on the repo in list view, in addition to Periodic Table view.

Add my new module

I made a module called Color Numbers, and I just released it so it should be put up on the repository.

Filtering using profiles does not work when using browser back/forward buttons

"If I were to filter by a profile on the repo, then leave the page and return to the page by clicking the forward or backward arrows (depending on which one is applicable) on the top-left corner of Chrome (didn't test other browsers), I am allowed to open a profile to filter by but it won't actually filter. The only way to fix it is to refresh the page or open the repo that's not from the buttons I mentioned earlier in this message. Is there a way to fix it where it won't fail to filter by profile under this circumstance?"

• Espik

Discord Embeds

Add Discord embeds to manual pages

• Title would be the name of the module and would like to the module.
• The embed would include the module SVG or the module Icons.
• The description would be the flavour text of the module (or maybe no description).

Allow ctrl+<number> to change highlight color

Hi,

Currently with my browser settings (Firefox on Linux w/ the Multi-Account Containers extension), alt+1-9 are bound to switching tabs (instead of ctrl+0-9 like on Windows), and ctrl+shift+1-9 to open a new tab in one of Multi-Account Containers' containers; neither have configurable modifier keys. Because of that, I can't comfortably switch highlight colors at all, so I'd like to suggest an option to switch from alt+1-9 to ctrl+1-9 for changing highlight colors. It's probably not worth changing alt+o, alt+c, etc. to ctrl, since those would conflict with much more universal browser shortcuts.

I'm mostly creating this issue to get thoughts from maintainers; I'm happy to take care of the implementation and send a pull request when done.

Thanks in advance!

Search function to have Regex option

requested by Danny7007#7431; on July 31, 2020

Search modules by their TP score

Requested by R4Y#0875; on August 3, 2020

"Is it ok if u can add a feature that can search for modules by their tp score.
Basically the ability to search all modules that have a score less/more than or equal to an inputted score."

Add the option for custom themes

This is a request from multiple users asking for the ability to change the theme for the repo to be custom.
I'd imagine people would like the option to use their own themes and then have the site remember them until cookies are deleted. I'm not completely sure on the details, though.

Have the ability for modules to have multiple tutorials linked.

Like a dropdown menu or something

Alt+Number keys change tabs in Firefox

Alt+1..8 changes to the first..eighth tabs in Firefox.

The highlighter is still usable... if you make sure you open all manual pages in new windows.

Filter for mod release year

requested by J88#2102; on July 28, 2020

Search/Filter by SteamID

"I'm wondering if a feature to search by SteamIDs could be added to the website for the repo? ... some mods have different listings for every module within them so it'd be nice to just search for the ID and get all of the modules"

• ElijahZAwesome

Ability to disable Steam ID search

Like Names/Authors/Descriptions

I was trying to search for the module "14" and it brought up a bunch of modules that have 14 in their Steam ID

Custom logging for Minecraft Survival

Minecraft Survival is a long module that has logging for every action taken. I propose to condense this up a bit so that each part of the logging has their own section:

• Gathering
• Crafting
• Fighting
  It'll make the log a lot easier to understand for users, and hopefully wouldn't result in a bunch of scrolling to see the entire thing.

Allow users to color coordinate the repo based on their mod profiles

"An idea where you can color the modules on the repo to indicate which modules you've learned, not learned, and are learning."

• Blananas2

Complicated Wires ruleseed code doesn't work

The ruleseed code for Complicated Wires.html is trying to getElementById('venn-ffff') and the like, but those IDs don't exist in the HTML so the page doesn't get updated with the new values.

Allow to search by boss/semi-boss mod

Add my newer module

I'm throwing another brick at your window and giving you another module to add.

The JSON you need

{ "Author": "R3Ked", "Compatibility": "Compatible", "DefuserDifficulty": "VeryEasy", "Description": "Press the button with the correct number on it based on two LEDs. Tags: one, two, two-buttons, two-leds", "ExpertDifficulty": "Easy", "ModuleID": "colorOneTwo", "Name": "Color One Two", "Origin": "Mods", "Published": "2020-07-25", "SortKey": "COLORONETWO", "SourceUrl": "https://github.com/siky112/ColorOneTwo", "SteamID": "2177850675", "Symbol": "Clot", "Type": "Regular" }

Git repo at https://github.com/siky112/ColorOneTwo

i am so tired and it's only 4 pm