Noah Petherbridge
93623e4e8a
Especially to further optimize memory for large levels, Levels and
Doodads can now read and write to a ZIP file format on disk with
chunks in external files within the zip.
Existing doodads and levels can still load as normal, and will be
converted into ZIP files on the next save:
* The Chunker.ChunkMap which used to hold ALL chunks in the main json/gz
file, now becomes the cache of "hot chunks" loaded from ZIP. If there is
a ZIP file, chunks not accessed recently are flushed from the ChunkMap
to save on memory.
* During save, the ChunkMap is flushed to ZIP along with any non-loaded
chunks from a previous zipfile. So legacy levels "just work" when
saving, and levels loaded FROM Zip will manage their ChunkMap hot
memory more carefully.
Memory savings observed on "Azulian Tag - Forest.level":
* Before: 1716 MB was loaded from the old level format into RAM along
with a slow load screen.
* After: only 243 MB memory was used by the game and it loaded with
a VERY FAST load screen.
Updates to the F3 Debug Overlay:
* "Chunks: 20 in 45 out 20 cached" shows the count of chunks inside the
viewport (having bitmaps and textures loaded) vs. chunks outside which
have their textures freed (but data kept), and the number of chunks
currently hot cached in the ChunkMap.
The `doodad` tool has new commands to "touch" your existing levels
and doodads, to upgrade them to the new format (or you can simply
open and re-save them in-game):
doodad edit-level --touch ./example.level
doodad edit-doodad --touch ./example.doodad
The output from that and `doodad show` should say "File format: zipfile"
in the headers section.
To do:
* File attachments should also go in as ZIP files, e.g. wallpapers
102 lines
2.4 KiB
Go
102 lines
2.4 KiB
Go
package doodads
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/json"
|
|
"fmt"
|
|
"io/ioutil"
|
|
"net/http"
|
|
"path/filepath"
|
|
|
|
"git.kirsle.net/apps/doodle/pkg/balance"
|
|
"git.kirsle.net/apps/doodle/pkg/usercfg"
|
|
)
|
|
|
|
// ToJSON serializes the doodad as JSON (gzip supported).
|
|
//
|
|
// If balance.CompressLevels=true the doodad will be gzip compressed
|
|
// and the return value is gz bytes and not the raw JSON.
|
|
func (d *Doodad) ToJSON() ([]byte, error) {
|
|
// Gzip compressing?
|
|
if balance.DrawingFormat == balance.FormatGZip {
|
|
return d.ToGzip()
|
|
}
|
|
|
|
// Zipfile?
|
|
if balance.DrawingFormat == balance.FormatZipfile {
|
|
return d.ToZipfile()
|
|
}
|
|
|
|
return d.AsJSON()
|
|
}
|
|
|
|
// AsJSON returns it just as JSON without any fancy gzip/zip magic.
|
|
func (d *Doodad) AsJSON() ([]byte, error) {
|
|
out := bytes.NewBuffer([]byte{})
|
|
encoder := json.NewEncoder(out)
|
|
if usercfg.Current.JSONIndent {
|
|
encoder.SetIndent("", "\t")
|
|
}
|
|
err := encoder.Encode(d)
|
|
return out.Bytes(), err
|
|
}
|
|
|
|
// FromJSON loads a doodad from JSON string (gzip supported).
|
|
func FromJSON(filename string, data []byte) (*Doodad, error) {
|
|
var doodad = &Doodad{}
|
|
|
|
// Inspect the headers of the file to see how it was encoded.
|
|
if len(data) > 0 && data[0] == '{' {
|
|
// Looks standard JSON.
|
|
err := json.Unmarshal(data, doodad)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
} else if len(data) > 1 && data[0] == 0x1f && data[1] == 0x8b {
|
|
// Gzip compressed. `1F8B` is gzip magic number.
|
|
if gzd, err := FromGzip(data); err != nil {
|
|
return nil, err
|
|
} else {
|
|
doodad = gzd
|
|
}
|
|
} else if http.DetectContentType(data) == "application/zip" {
|
|
if zipdoodad, err := FromZipfile(data); err != nil {
|
|
return nil, err
|
|
} else {
|
|
doodad = zipdoodad
|
|
}
|
|
}
|
|
|
|
// Inflate the chunk metadata to map the pixels to their palette indexes.
|
|
doodad.Filename = filepath.Base(filename)
|
|
doodad.Inflate()
|
|
|
|
return doodad, nil
|
|
}
|
|
|
|
// WriteJSON writes a Doodad to JSON on disk.
|
|
func (d *Doodad) WriteJSON(filename string) error {
|
|
json, err := d.ToJSON()
|
|
if err != nil {
|
|
return fmt.Errorf("Doodad.WriteJSON: JSON encode error: %s", err)
|
|
}
|
|
|
|
err = ioutil.WriteFile(filename, json, 0755)
|
|
if err != nil {
|
|
return fmt.Errorf("Doodad.WriteJSON: WriteFile error: %s", err)
|
|
}
|
|
|
|
d.Filename = filepath.Base(filename)
|
|
return nil
|
|
}
|
|
|
|
// LoadJSON loads a map from JSON file.
|
|
func LoadJSON(filename string) (*Doodad, error) {
|
|
data, err := ioutil.ReadFile(filename)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return FromJSON(filename, data)
|
|
}
|