Subscribe to download
Crypt of the NecroSpriter

A Steam workshop localised download of Crypt of the Necrospriter - A software to assist with animating in Crypt via. being able to live render updates to your spritesheets.

This is the STEAM EDITION, and simply exists for those whom don't know how to use Github and wish to have a version through steam instead. Be assured, everything the tool is made from is written in base Javascript, CSS and HTML - it's being hosted via. Steam for legitimacy purposes.

When it comes to using the tutorial video as a reference point, skip ahead after the Github install, as subscribing to this is the same process.

A lot of development time was spent creating this project, and wish to share the project with others - it would be great if you were to use this to create your resource packs to feature a link and reference a download source to support the project.

If you want to test the basic animation rendering, check it out here.[theavanherst.github.io]
This is just for software demonstration purposes, and won't allow you to edit spritesheets - you'll require a local download for that. (That's why this workshop item exists!)

Alternatively, you can find the software / raw code on Github[github.com]

If you need any assistance in using the tool, designing sprites or have any recommendations for the sprite renderer - create a new post in the discussions

If you wish to help future support of the software, I would GREATLY appreciate a donation via. Ko-fi.[ko-fi.com] Donating gives access to future development of all my projects.

• Start with going to your resource pack folder; Press esc on your keyboard > customize > resource packs. Find the workshop download of CtNS, and click on it. Open it by directory and it'll bring you to where it's locally installed. Make sure to make a shortcut to this, or simply drag the folder anywhere on your PC; where it's installed doesn't matter, just make sure you can access it easily.
  
• Double click 'main.html' and open it through your preferred browser.
  
• Updating spritesheets will require your own external software. Edited sheets can be updated via. the refresh button at the bottom right of the render view. Click refresh and repeat the process until you've got a result you want.
  
• Once you're happy with the result, save the version you have via. Necrospriter into your dedicated resource pack folder and upload to Steam!

Sprite-sheets are fully replaceable and interchangeable via the /characters folder - swap the associated character sheet and click the refresh icon under the render preview. You can also do the same thing by changing the URL via. the URL changer of the associated item and using the refresh button under the renderer to update the live preview.
Refreshing the page will clear any custom inserted urls as no cookie system is currently present in the current version of the software.

If you want to revert changes to a character sheet, all sheets have a backup via. `/characters_Backup`.

All the details below are to address how to change and tweak information relating to characters, and understanding is not necessary in order to use the software. This is all just back-end you CAN adjust.

Folder directories and code are both addressed via. " ' "

If you want a slightly clearer and easier to read explanation done with proper citation, you can read the exact same instructions via. Github[github.com]

Start up settings can be adjusted in '/settings.js', and contains startup data such as environment visibility & character settings.
Information regarding the settings will be included as general documentation.
These settings can be adjusted with NotePad, as long as it retains it's '.js' file format.

To change the file name of the associated character, '/Data_Libraries/characterData.js' contains all character related data, including associated image data. File urls are assigned by 'fileUrl: "{url}"' in the Settings object, with the extensions of each sheet (body & head) being assigned via. 'headExt:' and 'bodyExt:' respectively.
Examples of how to specify the directory are displayed in the text-boxes beforehand as an example. Eg; '"file root"/"imagename"."format"'.

Similar to character sheets, item directories on launch are determined by 'JS_Libraries/itemData.js'. Any invalid urls will be detected on page-start up and notify you after page initialization. Changing the boolean values in the itemData.js file will change their default visibility.

To add a character, add an object on the chain of characters in '/Data_Libraries/characterData.js' and it'll be added automatically and assigned to the associated DLC. DLCs are assigned via. 'dlc: {number}', and the name will be fetched via 'dlcTypes' at the top of the sheet. It is generally recommended to keep them associated with 'dlc: 3' for clarity.
Note: Adding a character as an object via. '/Data_Libraries/characterData.js' requires a page refresh to update.

If you wish to make adjustments to the sprite-sheet such as width / high per sprite, it can be adjusted via the settings under 'resolution'. These all can be found in 'characterDefaultSettings'.
A character's animation cycle is (as of right now) limited to 4 frames per second - hence the 'ampMultiplier' setting which uses a multiplier offset for character sheets that have different variants depending on the angle they are facing. As a result, 'ampMultiplier' is just an offset to the basic 4 frames, and is used as a multiplier - these can be seen by Klarinetta in 'characterData'.

If you require additional examples of dataset usage, refer to /data_Libraries/characterDefaultSettings.js.
This sheet contains all the available datatype that can be associated to characters.

• Hovering the cursor over the render window and scrolling has the same functionality as the scale slider.
  
• The BPM is slightly inaccurate and isn't a 100% accurate representation of the BPM as displayed.
  
• Character animation cycles are limited to 4 frames.
  
• All data relating to code has capitalized folder names and are unimportant for general usage.