Noah Petherbridge
5654145fd8
Finally add a second option for Chunk MapAccessor implementation besides the
MapAccessor. The RLEAccessor is basically a MapAccessor that will compress
your drawing with Run Length Encoding (RLE) in the on-disk format in the ZIP
file.
This slashes the file sizes of most levels:
* Shapeshifter: 21.8 MB -> 8.1 MB
* Jungle: 10.4 MB -> 4.1 MB
* Zoo: 2.8 MB -> 1.3 MB
Implementation details:
* The RLE binary format for Chunks is a stream of Uvarint pairs storing the
palette index number and the number of pixels to repeat it (along the Y,X
axis of the chunk).
* Null colors are represented by a Uvarint that decodes to 0xFFFF
or 65535 in decimal.
* Gameplay logic currently limits maps to 256 colors.
* The default for newly created chunks in-game will be RLE by default.
* Its in-memory representation is still a MapAccessor (a map of absolute
world coordinates to palette index).
* The game can still open and play legacy MapAccessor maps.
* On save in the editor, the game will upgrade/convert MapAccessor chunks over
to RLEAccessors, improving on your level's file size with a simple re-save.
Current Bugs
* On every re-save to RLE, one pixel is lost in the bottom-right corner of
each chunk. Each subsequent re-save loses one more pixel to the left, so what
starts as a single pixel per chunk slowly evolves into a horizontal line.
* Some pixels smear vertically as well.
* Off-by-negative-one errors when some chunks Iter() their pixels but compute
a relative coordinate of (-1,0)! Some mismatch between the stored world coords
of a pixel inside the chunk vs. the chunk's assigned coordinate by the Chunker:
certain combinations of chunk coord/abs coord.
To Do
* The `doodad touch` command should re-save existing levels to upgrade them.
128 lines
3.0 KiB
Go
128 lines
3.0 KiB
Go
package level
|
|
|
|
import (
|
|
"fmt"
|
|
"io/ioutil"
|
|
"os"
|
|
"runtime"
|
|
"strings"
|
|
|
|
"git.kirsle.net/SketchyMaze/doodle/assets"
|
|
"git.kirsle.net/SketchyMaze/doodle/pkg/branding"
|
|
"git.kirsle.net/SketchyMaze/doodle/pkg/enum"
|
|
"git.kirsle.net/SketchyMaze/doodle/pkg/filesystem"
|
|
"git.kirsle.net/SketchyMaze/doodle/pkg/log"
|
|
"git.kirsle.net/SketchyMaze/doodle/pkg/userdir"
|
|
"git.kirsle.net/SketchyMaze/doodle/pkg/wasm"
|
|
)
|
|
|
|
// ListSystemLevels returns a list of built-in levels.
|
|
func ListSystemLevels() ([]string, error) {
|
|
var names = []string{}
|
|
|
|
// Add the levels embedded inside the binary.
|
|
if levels, err := assets.AssetDir("assets/levels"); err == nil {
|
|
names = append(names, levels...)
|
|
}
|
|
|
|
// WASM
|
|
if runtime.GOOS == "js" {
|
|
// Return just the embedded ones, no filesystem access.
|
|
return names, nil
|
|
}
|
|
|
|
// Read filesystem for system levels.
|
|
files, err := ioutil.ReadDir(filesystem.SystemLevelsPath)
|
|
for _, file := range files {
|
|
name := file.Name()
|
|
if strings.HasSuffix(strings.ToLower(name), enum.DoodadExt) {
|
|
names = append(names, name)
|
|
}
|
|
}
|
|
|
|
return names, err
|
|
}
|
|
|
|
// LoadFile reads a level file from disk, checking a few locations.
|
|
func LoadFile(filename string) (*Level, error) {
|
|
if !strings.HasSuffix(filename, enum.LevelExt) {
|
|
filename += enum.LevelExt
|
|
}
|
|
|
|
// Search the system and user paths for this level.
|
|
filename, err := filesystem.FindFile(filename)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// Do we have the file in bindata?
|
|
if jsonData, err := assets.Asset(filename); err == nil {
|
|
log.Debug("Level %s: loaded from embedded bindata", filename)
|
|
return FromJSON(filename, jsonData)
|
|
}
|
|
|
|
// WASM: try the file from localStorage or HTTP ajax request.
|
|
if runtime.GOOS == "js" {
|
|
if result, ok := wasm.GetSession(filename); ok {
|
|
log.Info("recall level data from localStorage")
|
|
return FromJSON(filename, []byte(result))
|
|
}
|
|
|
|
// Ajax request.
|
|
jsonData, err := wasm.HTTPGet(filename)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return FromJSON(filename, jsonData)
|
|
}
|
|
|
|
// Load as JSON.
|
|
if level, err := LoadJSON(filename); err == nil {
|
|
return level, nil
|
|
} else {
|
|
log.Warn(err.Error())
|
|
return nil, err
|
|
}
|
|
}
|
|
|
|
// WriteFile saves a level to disk in the user's config directory.
|
|
func (m *Level) WriteFile(filename string) error {
|
|
if !strings.HasSuffix(filename, enum.LevelExt) {
|
|
filename += enum.LevelExt
|
|
}
|
|
|
|
// Set the version information.
|
|
m.Version = 1
|
|
m.GameVersion = branding.Version
|
|
|
|
// Maintenance functions, clean up cruft before save.
|
|
if err := m.Vacuum(); err != nil {
|
|
log.Error("Vacuum level %s: %s", filename, err)
|
|
}
|
|
|
|
bin, err := m.ToJSON()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// Save it to their profile directory.
|
|
filename = userdir.LevelPath(filename)
|
|
log.Info("Write Level: %s", filename)
|
|
|
|
// WASM: place in localStorage.
|
|
if runtime.GOOS == "js" {
|
|
log.Info("wasm: write %s to localStorage", filename)
|
|
wasm.SetSession(filename, string(bin))
|
|
return nil
|
|
}
|
|
|
|
// Desktop: write to disk.
|
|
err = os.WriteFile(filename, bin, 0644)
|
|
if err != nil {
|
|
return fmt.Errorf("level.WriteFile: %s", err)
|
|
}
|
|
|
|
return nil
|
|
}
|