|
1 | | -# mbit-more |
2 | | -Another micro:bit extension for Scratch3. |
| 1 | +<h1 align="center">scratch-microbit-more</h1> |
| 2 | +<p> |
| 3 | + <img alt="Version" src="https://img.shields.io/badge/version-0.5.0-blue.svg?cacheSeconds=2592000" /> |
| 4 | + <a href="https://yokobond.github.io/scratch-microbit-more" target="_blank"> |
| 5 | + <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" /> |
| 6 | + </a> |
| 7 | + <a href="https://github.com/yokobond/scratch-microbit-more/graphs/commit-activity" target="_blank"> |
| 8 | + <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" /> |
| 9 | + </a> |
| 10 | + <a href="https://github.com/yokobond/scratch-microbit-more/blob/trunk/LICENSE" target="_blank"> |
| 11 | + <img alt="License: MIT" src="https://img.shields.io/github/license/yokobond/scratch-microbit-more" /> |
| 12 | + </a> |
| 13 | +</p> |
| 14 | + |
| 15 | +> Full-functional extension of micro:bit for Scratch3 |
| 16 | +
|
| 17 | +### ✨ Open [Microbit More Web-App](https://yokobond.github.io/scratch-microbit-more) |
| 18 | + |
| 19 | +### 🏠 [Homepage](https://lab.yengawa.com/project/scratch-microbit-more/) |
| 20 | + |
| 21 | +## Setup Development Environment |
| 22 | + |
| 23 | +Download the Scratch3 repositories according to the supporsed directory configuration. |
| 24 | + |
| 25 | +``` |
| 26 | +. |
| 27 | +|-- scratch-microbit-more |
| 28 | +|-- scratch-vm |
| 29 | +|-- scratch-gui |
| 30 | +``` |
| 31 | + |
| 32 | +Install node modules and setup to use local repo for development. |
| 33 | + |
| 34 | +```sh |
| 35 | +cd ./scratch-microbit-more |
| 36 | +npm install |
| 37 | +npm run setup:local |
| 38 | +npm run install:local |
| 39 | +``` |
| 40 | + |
| 41 | +## Install into Scratch3 |
| 42 | + |
| 43 | +To install this extention into your selfbuild Scratch3, execute `scripts/install.js` with options as follows. |
| 44 | + |
| 45 | +```sh |
| 46 | +node ./scripts/install.js --gui="../scratch-gui" --vm="../scratch-gui/node_modules/scratch-vm" --url="https://yokobond.github.io/scratch-microbit-more/dist/microbitMore.mjs" |
| 47 | +``` |
| 48 | + |
| 49 | +- --gui : location of scratch-gui from current dir. |
| 50 | +- --vm : location of scratch-vm form current dir. |
| 51 | +- --url : URL to get its module as a lodable extension for Xcratch. |
| 52 | + |
| 53 | +**CAUTION:** This script will change '`extension default`' in `scratch-gui/src/lib/libraries/extensions/index.jsx` as follows. |
| 54 | + |
| 55 | +change from the original code |
| 56 | + |
| 57 | +```js |
| 58 | +export default [...]; |
| 59 | +``` |
| 60 | + |
| 61 | +to |
| 62 | + |
| 63 | +```js |
| 64 | +const extensions = [...]; |
| 65 | +export default extensions; |
| 66 | +``` |
| 67 | + |
| 68 | +It may break installation mechanism of the other extensions. |
| 69 | + |
| 70 | + |
| 71 | +## Xcratch Module Building |
| 72 | + |
| 73 | +Build module as loadable extension for [Xcratch](https://github.com/yokobond/xcratch). |
| 74 | + |
| 75 | +```sh |
| 76 | +node ./scripts/build.js --name=microbitMore --block="./src/block" --entry="./src/entry" --vm="../scratch-vm" --gui="../scratch-gui" --output="./dist" |
| 77 | +``` |
| 78 | + |
| 79 | +- --name: name of the module file (without '.mjs'). |
| 80 | +- --block : location of block files from current dir. |
| 81 | +- --entry : location of entry files from current dir. |
| 82 | +- --gui : location of scratch-gui from current dir. |
| 83 | +- --vm : location of scratch-vm form current dir. |
| 84 | +- --output : location to save module form current dir. |
| 85 | + |
| 86 | +## Author |
| 87 | + |
| 88 | +👤 **Koji Yokokawa** |
| 89 | + |
| 90 | +* Website: http://www.yengawa.com/ |
| 91 | +* Github: [@yokobond](https://github.com/yokobond) |
| 92 | + |
| 93 | +## 🤝 Contributing |
| 94 | + |
| 95 | +Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/yokobond/scratch-microbit-more/issues). You can also take a look at the [contributing guide](https://github.com/yokobond/scratch-microbit-more/blob/master/CONTRIBUTING.md). |
| 96 | + |
| 97 | +## Show your support |
| 98 | + |
| 99 | +Give a ⭐️ if this project helped you! |
| 100 | + |
| 101 | +[Donate](https://yokobond.github.io/scratch-microbit-more/donation.html) if this project is worth for you. |
| 102 | + |
| 103 | + |
| 104 | +## 📝 License |
| 105 | + |
| 106 | +Copyright © 2020 [Koji Yokokawa](https://github.com/yokobond).<br /> |
| 107 | +This project is [MIT](https://github.com/yokobond/scratch-microbit-more/blob/trunk/LICENSE) licensed. |
| 108 | + |
| 109 | +*** |
| 110 | +_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_ |
0 commit comments