Code Monkey home page Code Monkey logo

sc-debugger's Introduction

scDebugger (Development on hiatus)

A debug tool for SugarCube v2, to be used primarily with Twee Compilers.

Displays a list of all story variables, and allows editing their current values.

scd-screencap-01 scd-screencap-02 scd-screencap-03


Installation

First Clone or Download this repository. The .zip file contains both the minified-drop-to-use and pretty-you-wanna-know-what-it-does versions of the code. Pick your choice and go to town with it.

If using the Twine app

From inside the dist-scd directory, copy contents of scDebuggerScript.min.js into your Story Javascript section, scDebuggerStyle.min.css into your Story Stylesheet section.

Then finally, copy contents of scDebuggerMarkup.tw into a passage named sc-debugger and add nobr as a tag. Delete this line from the top:

:: sc-debugger [nobr]

If using a Twee compiler

Drop the dist-scd directory containing scDebuggerScript.min.js, scDebuggerStyle.min.css and scDebuggerMarkup.tw into your source directory.


Usage

Press = on your keyboard to open the debugger!


Planned additions

  • Grouping / Multiple Tabs
  • Locked values
  • A Chrome extension

! Note

scDebugger uses Lodash.js. If you (somehow) already use it in your project, download only the components from the src directory (exclude Lodash from your project source).


Changelog

  • v0.1.2

    • Fixed issue regarding dot notation being used for invalid object property identifiers.
    • Changed <div> ID naming to a number based system instead of slugified variable names to avoid ambiguity while setting variable values.
  • v0.1.1

    • Styling changes. The UI now looks more consistent across projects.
    • Tweaks of how the variable names are displayed. Now they're more akin to how you'd define and access Story variables in SugarCube v2.
  • v0.1.0

    • Initial release.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.