-
Notifications
You must be signed in to change notification settings - Fork 49
/
Copy pathReadmePlugin.mjs
174 lines (125 loc) · 6.86 KB
/
ReadmePlugin.mjs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
// a Very Bad readme generator
import doctrine from 'doctrine';
import fs from 'fs';
import getHacks from './getHacks';
import pkg from './package.json';
const l = getHacks().length;
const headers = [];
function write() {
var contents = headers
.filter(h => h)
.map(header =>
doctrine.parse(header, {
unwrap: true,
recoverable: true,
})
)
.map(jsdoc => {
var o = {};
o.emoji = jsdoc.description;
Object.values(jsdoc.tags).forEach(tag => {
o[tag.title] = tag.description;
});
o.file = o.file || '';
o.url = `/dist/${encodeURI(o.file.replace(/\s/g, '-'))}.js`;
return o;
})
.sort((a, b) => a.file.localeCompare(b.file, 'en', { sensitivity: 'base', ignorePunctuation: true }));
fs.writeFileSync(
'README.md',
`# bitsy hacks
\`\`\`sh
npm i ${pkg.name}
\`\`\`
A collection of re-usable scripts for [Adam Le Doux](https://twitter.com/adamledoux)'s [Bitsy Game Maker](https://ledoux.itch.io/bitsy). See [Ayolland's Borksy](https://ayolland.itch.io/borksy) for a GUI that allows you to use these hacks with less copy-pasting.
Last tested against Bitsy ${pkg.bitsyVersion}
- [Contents](#contents)
- [How to use](#how-to-use)
- [FAQ](#FAQ)
- [Old Versions](#old-versions)
- [Further reading](#further-reading)
## Contents
${contents.map(hack => `- ${hack.emoji} [${hack.file}](${hack.url}): ${hack.summary}`).join('\n')}
## How to use
Each script has a short "HOW TO USE" section included in the comments. For steps which say to \`Copy-paste this script into a script tag after the bitsy source\`, open your exported bitsy game and scroll to the bottom of the file (at the time of writing, it looks like this):
\`\`\`html
</script>
</head>
<!-- DOCUMENT BODY -->
<body onload='startExportedGame()'>
<!-- GAME CANVAS -->
<canvas id='game'></canvas>
</body>
</html>
\`\`\`
then edit it to look like this:
\`\`\`html
</script>
<script>
// and then paste your code here!
</script>
</head>
<!-- DOCUMENT BODY -->
<body onload='startExportedGame()'>
<!-- GAME CANVAS -->
<canvas id='game'></canvas>
</body>
</html>
\`\`\`
## FAQ
- > I don't know javascript. Can I still use the hacks?
Yes, most of the hacks require little to no javascript experience.
- > Can I import a hacked file back into the Bitsy editor?
Yes, but unfortunately only the gamedata will be imported, and the hacks will be lost. To edit a hacked game, it's recommended that you keep a copy of the hacked html file, and copy-paste edited gamedata into it. If you need to do this a lot, there are a few tools available to speed up your workflow (e.g. [bitsy-savior](https://aloelazoe.itch.io/bitsy-savior), [Borksy](https://ayolland.itch.io/borksy), [bitsy-boilerplate](https://github.com/seleb/bitsy-boilerplate)).
- > Some of these hack files are kinda long. Do I need to copy the whole thing?
Yes, you need the entire hack file in order for it to work. If for some reason you're *really* concerned with filesize (you shouldn't be), you can programmatically compose and minify them (either by cloning this repo or by using the [bitsy-boilerplate](https://github.com/seleb/bitsy-boilerplate) project), but this is only recommended for developers familiar with javascript bundling.
- > Can I combine multiple hacks?
Yes, but there are [known issues with specific combinations](https://github.com/seleb/bitsy-hacks/issues?q=is%3Aissue+label%3Amulti-hack+). If you're having issues using multiple hacks, try testing them one at a time to make sure they've each been setup correctly.
- > Do the hacks work with forks like [Bitsy 3D](https://aloelazoe.itch.io/bitsy-3d), [Bitsy HD](https://vonbednar.itch.io/bitsy-x2), or [Bitsy Color](https://aurysystem.itch.io/multicolorbisty)?
It varies by hack and by fork. If something doesn't work, try testing against a regular Bitsy game to make sure you've setup the hack correctly.
Bitsy HD in particular is a fairly old fork, and generally needs [older versions of hacks](https://github.com/seleb/bitsy-hacks/tree/d419cf6b84822a6419a78ad82336333771b27bf0/dist).
- > Do the hacks work with emulators like [bitsy boutique](https://candle.itch.io/bitsy-boutique) or [bitsybox](https://ledoux.itch.io/bitsybox)?
No. Emulators function by re-implementing parts of the engine and/or browser into another environment, but the hacks rely heavily on how the engine is structured and how the browser handles \`<script>\` tags. However, desktop projects which preserve the original engine/browser context (e.g. [Electron](https://www.electronjs.org/), [NW.js](https://nwjs.io/)) can be used.
If your question isn't covered here, it may be in the general [Bitsy documentation](https://make.bitsy.org/docs).
For other issues, feel free to [open an issue](https://github.com/seleb/bitsy-hacks/issues/new), [contact me directly](https://seans.site#contact), or ask for help on the [Bitsy forum](https://ledoux.itch.io/bitsy/community)!
## Old Versions
Bitsy and the hacks are generally not backwards-compatible: when Bitsy updates, it often breaks individual hacks. If you're having issues with hacks after a Bitsy update, it's possible they are out of date. Feel free to reach out for help or open an issue if you suspect this is the case.
If you are using an older version of Bitsy (or a fork based on an older version), you may require old versions of the hacks. Support is not guaranteed across versions, and old versions are not maintained, but some helpful points in history are listed below.
- [Bitsy 7.12](https://github.com/seleb/bitsy-hacks/tree/v20.2.5/dist)
- [Bitsy 7.11](https://github.com/seleb/bitsy-hacks/tree/v19.2.7/dist)
- [Bitsy 7.8-7.9](https://github.com/seleb/bitsy-hacks/tree/v17.0.0/dist)
- [Bitsy 7.2-7.7](https://github.com/seleb/bitsy-hacks/tree/v16.0.3/dist)
- [Bitsy 5.1](https://github.com/seleb/bitsy-hacks/tree/d419cf6b84822a6419a78ad82336333771b27bf0/dist)
## Further reading
- [Writing hacks with this repo's source code](https://github.com/seleb/bitsy-hacks/wiki)
- [Claire Morley's "A Bitsy Tutorial"](http://www.shimmerwitch.space/bitsyTutorial)
- [Bitsy games!](https://itch.io/games/tag-bitsy)
- [elkie's bitsy-savior](https://aloelazoe.itch.io/bitsy-savior): Safe saver
- [ruin's image-to-bitsy](https://ruin.itch.io/image-to-bitsy): Artistic aid
- [Fontsy](https://seansleblanc.itch.io/Fontsy): Typographic tool`
);
}
// eslint-disable-next-line import/no-default-export
export default function () {
return {
// grab headers
renderChunk(code) {
const pattern = /^(\/\*\*[\S\s]*?\*\/)$/gm;
const matches = code.match(pattern);
if (!matches) {
console.warn("Couldn't find jsdoc");
headers.push(null);
return code;
}
const header = matches[matches.length - 1];
headers.push(header);
return code;
},
writeBundle() {
if (headers.length === l) {
write();
}
},
};
}