getkey / ble Goto Github PK

The current algorithm looks at all the segments and find the ones that have a point closest to the vertex you are trying to add.

But in some cases, 2 segments can fit these criteria, in which case, a segment gets randomly chosen. For a human, it would make more sense that the chosen segment be the one whose second point is closest.

More context: https://discordapp.com/channels/526188679006388254/601609930486841365/737049529869926482

(This issue is labeled as good first issue because you don't need to know the codebase well to contribute, not because of the difficulty of implementing the algorithm 🙂)

As a continuation of #38

• separate move and select in the toolbar
• make a selection box with the mouse
• select objects on pointerup (using https://github.com/jriecken/sat-js and https://github.com/schteppe/poly-decomp.js)
• Ctrl shortcut for adding to/removing from an existing selection

https://discord.com/channels/526188679006388254/644549821922803712/709806784063471717

Conceptually, this editor has 4 category of tools:

• Edition tools
  • Select
  • Create vertex
  • Create entity
  • Clear level
  • Set grid size (can it also be considered a level setting?)
• Level settings
  • Level name
  • Stars
• Meta-tools
  • Save file
  • Load file
  • Upload
  • Test
  • Home
  • Undo/redo
• Entity specific tools
  • Rotation
  • Bombs
  • Text content
  • Staticness
  • Text content
  • etc.

New design idea

A bar on the top that goes accros the window. On the top left, the level name and the stars. On the top right, the meta-tools. On small screens, the meta-tools move below the level name and the stars

The edition tools are floating ~10px below that bar, on the left.

Some inspiration:

Filter the events using event.target if possible. If not, use stopPropagation in the areas that shouldn't cause zooming.

More context: https://discordapp.com/channels/526188679006388254/601609930486841365/750084423218757664

Removing a point isn't a big deal, no need to have a confirmation popup.

I might revisit this issue once #19 is done, as confirmation popups in general will become less useful (and still cause frictions) when there is a possibility to undo.

https://discord.com/channels/526188679006388254/681629693501243393/785361892281417758

1. investigate why this is happening even though zoom buttons are, well buttons, that shouldn't be selectable by default. Some possibilities:
   • the button is actually small and contained into something selectable?
   • the ButtonReset resets too many things?
   • buttons actually are selectable on some platforms?
2. Fix accordingly

https://discord.com/channels/526188679006388254/601609930486841365/810615233068269599

Right now you have to put the ID.

To avoid this validation error:
https://discord.com/channels/526188679006388254/526188679006388256/803699622777978921
https://discord.com/channels/526188679006388254/681629693501243393/799384549666717706

This will fix the grid snapping. That wasn't addressed in #21

https://discord.com/channels/526188679006388254/601609930486841365/8960475398061588

Support for having multiple entities selected.

• Ctrl+clic shortcut
• entity params box shows something meaningful (maybe just "X entities selected" for a start)
• copy-pasting works
• moving entities around works

Out of scope:

• selection box: it would need a new select mode in the editor because currently the behavior when click-dragging is panning the level.

https://discord.com/channels/526188679006388254/644549821922803712/702588436015742977
https://discord.com/channels/526188679006388254/644549821922803712/709806784063471717

More context: https://discordapp.com/channels/526188679006388254/644549821922803712/712063659395776513

Using @ErikSom's trick of compressing JSON, then turning it into base64 so prefabs can be shared on Discord.

Let's use https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs as the format.
A good compression algorithm is necessary because Discord's character limit per message is presently 2000.

data:application/bombhopperio-prefab+json;compression=lz-string;base64,NobwRALgngDgpmAXJOAPCYA0YYEMBOuAtgM5LipIBMADDdlEgKy3YDGA9jI4uHAHZIwAFQAWASxIACSVIii4UgCZwAZrgCuAGwhStcAG5wtAQgA6/AKJLxuiBylQOG/HvEBrcfwDmYAL7YuPxsohz45GCUiDQAdEwMSLFMAWBB3vqJfgHg0PBC/GFEuFpYOATEZLxgRvgQ4mxwlaCRSAAsdAmIABy02S2I7fRgPF1dNH1RLEMjYxPMrMNIPeMAutiSAMoQuHVsSBD4GnBZmDmwCMj1CNh4hKQRNbuNSM1RALRUAGzTzLOn/R9vp1lnMBh1Ft1ev8ooNOgB2b6ggCMQIhCPG0KQHx+iE+7VBbyR7U6eNW6xIWx29X2h2OfVyFzAAiUMA4XgwN3K9yqkyYOM+AGYhpttrsaUdsPhxN5RBAAGK4NheXyIA4S1I+DLRE5nPLIGBaXBQODhTl3SoULGonifBZpLXCimi6mIdRaEhwbBFby4ABeXguwDA3nwAlwKlKcCIMGgpQARtp9BgVjrIOd8oViqVbhUHiank1LYgPgLPp0qABOKgEpEI8tVmt1iEClgEqilzot6trMAiql7V3FD1ZFZAA

Tour of the compression algorithms

• lz-string: works well (sadly operates only on strings, so array buffers need to be turned into strings)
• lzma: works well, small file size
• brotli: dependency is too big to include in this project
• zstd: https://www.npmjs.com/package/zstddec is to be tested, others are too big

My tests

How small can the entities in this level can turn out to be?

The comparisons below are done on base64 strings, close to real-world.

• json + lz-string: 1712B
• messagepack + lz-string: 1312B 5ms
• messagepack + lzma: 872B 77ms

Some naive non-base64 benchmarks (because they all use the default paramters)

615 msgPacked.bin.br
638 msgPacked.bin.zopfli.deflate
644 msgPacked.bin.zopfli.zlib
652 msgPacked.bin.lzma
656 msgPacked.bin.zopfli.gzip
668 msgPacked.bin.lz
682 msgPacked.bin.bz2
690 msgPacked.bin.gz
700 msgPacked.bin.xz
721 msgPacked.bin.lzham
762 msgPacked.bin.zst
1018 msgPacked.bin.lzo
1035 msgPacked.bin.lz4
1065 msgPacked.bin.Z
2464 msgPacked.bin

TL;DR: the lzma module is sturdy and has a good ratio, so let's use that. (but let's make sure the service worker works since it's slow!)

The prefix will be as follow: data:application/vnd.bombhopperio-prefab+msgpack;compression=lzma;base64

More context: https://discordapp.com/channels/526188679006388254/644549821922803712/680178131352551455

Suggestion <@211137158814105601>

Make selection dotted and moving, to help people with visual impairments (in particular for fire block where the selection isn't super obvious)

https://codepen.io/unrealnl/pen/aYaxBW

When a parameter is common to all entities in the group, it should be possible to set it for all entities at once.

• delete
• radius
• etc

https://discord.com/channels/526188679006388254/644549821922803712/814024854906863666

Currently, pasted objects appear at the center of the screen. It would be nice if the top-left corner of their AABB could be aligned to the grid.

https://discordapp.com/channels/526188679006388254/601609930486841365/680162401064058899

Right now the editor allows you to set any digit as the star timing.

But actually it must be an integer in millisecond (or in seconds, have a maximum of 3 decimal places).

Currently, if you put for example 9.9999999999 as the number of seconds then try to save the level file, it will complain that the level is corrupted.

How to reproduce:

• select create tool
• place the first point
• delete it (without switching to another tool)
• place a new point
• get error below

add.ts:65 Uncaught Error: Trying to add a vertex but no entity is selected
    at t._tapNext (add.ts:65)
    at t._next (tap.js:45)
    at t.next (Subscriber.js:53)
    at t._next (filter.js:38)
    at t.next (Subscriber.js:53)
    at t.next (Subject.js:47)
    at t._tapNext (control.js:11)
    at t._next (tap.js:45)
    at t.next (Subscriber.js:53)
    at t.notifyNext (mergeMap.js:87)

An elegant fix for this would need mobxjs/mobx-state-tree#1540 to be merged, in the meantime, this issue is blocked 🙂

Seconds seem to be more intuitive than what we have currently: milliseconds (see https://discord.com/channels/526188679006388254/680197233337172092/785193162246586368 and the uploads above the Discord message).

For example:

• Balls of radius = 0
• Blocks with points in the same place

The editor should warn you that if you unselect this polygon, it will be destroyed since it's invalid. But you will also be given the option to cancel to keep your invalid polygon selected so you can fix it.

Unselecting this polygon will remove it because it is invalid. Are you fine with that?
[Cancel] [OK]

More context: WMGX on Discord

Context & original bug report: https://discord.com/channels/526188679006388254/601609930486841365/772917528170594304

More context: https://discord.com/channels/526188679006388254/601609930486841365/824694830554153010

Right now the cursor changes to the grabby hand, but when you click, nothing happens.

While mobile zooming may have been added panning around in a zoomed in state is still impossible.

It's not intuitive at all.

More context: https://discord.com/channels/526188679006388254/526188679006388256/789505741194657803

https://discord.com/channels/526188679006388254/601609930486841365/885888407656628284

Context & original bug report: https://discord.com/channels/526188679006388254/601609930486841365/772917528170594304

More context

https://discord.com/channels/526188679006388254/601609930486841365/806012357120884736

Right now only vertices snap to the grid. Other entites such as doors and hoppis merely move by a multiple of grid.

More context: https://discordapp.com/channels/526188679006388254/526188679006388256/721467026589352047

On mobile, it is difficult to use the handles when zoomed out.

More context: https://discordapp.com/channels/526188679006388254/680197233337172092/735164809300934756

Possible fixes:

1. remove all invalid entities, set the title to the default
2. do not save anything until the level becomes valid again

https://discord.com/channels/526188679006388254/601609930486841365/805919281715740672

People often more naturally right-click than use shortcuts. Also, you can't use the shortcuts on mobile.

In the first version, it would have copy, cut and paste (more things can be added to it later).

It needs to be able to trigger with:

• contextmenu event on desktop
• long press on mobile

This parameter can flip vertically the texture of doors. The game supports it, it's used in some official levels (Choice on the top of my head). But the editor doesn't support the feature.

https://github.com/getkey/bombhopperio-level-tools/blob/e9ce9beaa02b9f79349da370b623a9b9253b8571/src/entity.schema.json#L192-L194

Right now, the editor is a standalone application. When it's loaded in the game, it's via an iframe, which is slow. If Blé was a library that could be directly used by the game, it could be cached more efficiently, and it would only be downloaded once per gaming session. Besides, common dependencies would be shared by the game and the editor.

API proposal

import { Ble } from 'ble';

const ble = new Ble(document.getElementById('ble-app'));

ble.loadLevel(someLevel);
const currentLevel = ble.getCurrentLevel();

// later
ble.destroy();

Sometimes levels can contain long numbers, probably because of floating point issues. It increases the size of levels while not adding any useful information.

		{
			"type": "deadly",
			"params": {
				"isStatic": true,
				"vertices": [
					{
						"x": 300,
						"y": -88.00000000000001
					},
					{
						"x": 300,
						"y": -89.00000000000001
					},
					{
						"x": 290,
						"y": -109.00000000000001
					},
					{
						"x": 280,
						"y": -89.00000000000001
					},
					{
						"x": 270,
						"y": -109.00000000000001
					},
					{
						"x": 260,
						"y": -89.00000000000001
					},
					{
						"x": 250.00000000000003,
						"y": -109.00000000000001
					},
					{
						"x": 240.00000000000003,
						"y": -89.00000000000001
					}

It would be great if the levels could be optimized, either:

• automatically in the editor after each edition
• automatically in the editor on upload
• manually in the editor (a button that asks the precision you need?)
• automatically by the backend

I'm not sure what's the best option for now, so tracking that here. I've added the functionality to BLT: getkey/bombhopperio-level-tools@e0134d8, which should be useful whatever the decision.

Instead of using the menu (suggested by flo_again#8602)

https://discord.com/channels/526188679006388254/601609930486841365/809583734931456060

https://discord.com/channels/526188679006388254/644549821922803712/897047856244994078

More context

The interface takes up a lot of screen space on mobile. It should be hidden in a hamburger menu.

https://discord.com/channels/526188679006388254/601609930486841365/804338433085407242

Replace the dropdown menu with a library (located on the side perhaps) from which entities can be dragged and dropped into the editor.

Useful for:

• moving objects
• copy-pasting objects

More context: https://discord.com/channels/526188679006388254/644549821922803712/702588436015742977

Suggest adding some sort of formatted error message.