Code Monkey home page Code Monkey logo

bitsy-optimizer's Introduction

@bitsy/optimizer

optimizer for bitsy gamedata

A few things to note:

  • Optimizations are written in terms of vanilla bitsy; many hacks may use gamedata which would otherwise be seen as "unused" in a vanilla bitsy game (e.g. a room may have no exits pointing to it, but still be used via exit-from-dialog tags), so be wary of this when choosing what to optimize.
  • Dialog scripts are not taken into account, which means data only referenced in dialog (e.g. an audio blip in 8.0 that is called from dialog but not directly assigned to any sprite/item) will be removed and may break your game.
  • Make sure to save a backup in case you remove something unintentionally as part of optimizing!

How To

Browser

  1. include ./dist/index.iife.js in HTML

    <script src="vendor/@bitsy/optimizer/dist/index.iife.js"></script>
  2. reference global

    const optimize = window.bitsyOptimizer;

Node

  1. install

    npm install @bitsy/optimizer --save
  2. import

    const optimize = require("@bitsy/optimizer");
    import optimize from '@bitsy/optimizer';

Use

const gamedata = `Write your game's title here

# BITSY VERSION 6.0...`;

const optimizedGamedata = optimize(gamedata);

// options can be provided as a second parameter
const partiallyOptimizedGamedata = optimize(gamedata, {
	rooms: true || false,    // removes unreachable rooms (except room 0)
	palettes: true || false, // removes unused palettes that aren't assigned to any rooms
	tiles: true || false,    // removes tiles that aren't placed in any rooms
	sprites: true || false,  // removes sprites that aren't placed in any rooms or used as an avatar
	items: true || false,    // removes items that aren't placed in any rooms
	dialogue: true || false, // removes dialogue that isn't assigned to any sprites or items
	exits: true || false,    // removes exits that don't go to valid rooms
	endings: true || false,  // removes endings that aren't placed in any rooms
	tunes: true || false,    // removes tunes that aren't placed in any rooms
	blips: true || false,    // removes blips that aren't assigned to any sprites or items
});

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.