-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
59 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,50 +1,59 @@ | ||
# React + TypeScript + Vite | ||
|
||
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. | ||
|
||
Currently, two official plugins are available: | ||
|
||
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh | ||
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh | ||
|
||
## Expanding the ESLint configuration | ||
|
||
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: | ||
|
||
- Configure the top-level `parserOptions` property like this: | ||
|
||
```js | ||
export default tseslint.config({ | ||
languageOptions: { | ||
// other options... | ||
parserOptions: { | ||
project: ['./tsconfig.node.json', './tsconfig.app.json'], | ||
tsconfigRootDir: import.meta.dirname, | ||
}, | ||
}, | ||
}) | ||
``` | ||
|
||
- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked` | ||
- Optionally add `...tseslint.configs.stylisticTypeChecked` | ||
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config: | ||
|
||
```js | ||
// eslint.config.js | ||
import react from 'eslint-plugin-react' | ||
|
||
export default tseslint.config({ | ||
// Set the react version | ||
settings: { react: { version: '18.3' } }, | ||
plugins: { | ||
// Add the react plugin | ||
react, | ||
}, | ||
rules: { | ||
// other rules... | ||
// Enable its recommended rules | ||
...react.configs.recommended.rules, | ||
...react.configs['jsx-runtime'].rules, | ||
}, | ||
}) | ||
``` | ||
# Playerchain Demo Map Editor | ||
|
||
Try it out here: https://playmint.github.io/substream-map-editor/ | ||
|
||
## Controls | ||
|
||
### General Controls | ||
|
||
- **[Space]**: Start a new line. Press again to complete the current line. | ||
- **[Enter]**: Complete the current line. | ||
- **[Escape] / [Space]**: Cancel drawing the current line. | ||
- **[z]**: Undo the last point added while drawing a line. | ||
- **[Tab]**: Toggle the sidebar on/off. | ||
- **[m]**: Mirror lines across all quadrants. | ||
- **[0]**: Reset camera position to the center. | ||
|
||
### Line Drawing and Deletion | ||
|
||
- **Mouse Click**: Add a point to the current line. | ||
- **Shift + Mouse Click**: Pan the camera view. | ||
- **Right-Click**: Cancel drawing the current line. | ||
- **Delete Button (on the sidebar)**: Delete an existing line. | ||
|
||
### Camera Controls | ||
|
||
- **[Shift + Mouse Drag]**: Pan the camera. | ||
- **[+ / =]**: Zoom in the camera view. | ||
- **[- / _]**: Zoom out the camera view. | ||
- **Scroll Wheel** (while holding **Shift**): Zoom in/out smoothly. | ||
|
||
### Other Controls | ||
|
||
- **[ [ ]**: Decrease wall thickness. | ||
- **[ ] ]**: Increase wall thickness. | ||
- **[Slider/Input Box]**: Adjust the spawn radius value. | ||
|
||
## Features | ||
|
||
- **Mirror Mode**: Use the `m` key or the checkbox in the sidebar to mirror your lines across all four quadrants. | ||
- **Wall Thickness Adjustment**: Modify the thickness of the walls using `[ ]` keys or the sidebar controls. | ||
- **Spawn Radius**: Adjust the spawn radius using the slider or input box in the sidebar. | ||
- **Import/Export**: Easily import and export your line configurations. | ||
|
||
## Exporting Maps | ||
|
||
- Use the "Export to Substream" button in the sidebar to save your map configuration for use in Substream. | ||
|
||
## Audio | ||
|
||
- **Enable Audio Checkbox**: Toggle audio feedback when using the editor. | ||
|
||
## Notes | ||
|
||
- The cursor changes based on context: | ||
- **Crosshair**: Default state. | ||
- **Grab**: Hovering with **Shift** pressed. | ||
- **Grabbing**: Panning while dragging with **Shift** pressed. | ||
|
||
--- |