diff options
| author | Nicolas Paul <n@nc0.fr> | 2024-03-09 21:52:37 +0100 |
|---|---|---|
| committer | Nicolas Paul <n@nc0.fr> | 2024-03-09 21:52:37 +0100 |
| commit | 6c7211f27c6243928d7d008ad8f96ad316e0ca23 (patch) | |
| tree | e3ad57e0845caf4257a3ce4b4cb675b0ddcc6251 | |
| parent | 8f8f649b8a0af56c1fa726b674ac084174ff7032 (diff) | |
format: Add L2TF implementation
(A spec might come later)
The Life2 Text Format (L2TF) is a ASCII-based file format that allows
the sharing of a Life2 board easily. The format is designed to be easy
to parse by both machines and humans, as it is pretty natural,
reprensenting a grid as a set of lines.
As said in the beginning, the format is currently only defined in the
index.js file, however a specification will be done later (probably
during the week), for now, this is enough.
Currently, the format is composed of the following:
CELL KIND CHARACTER UINT8 REPR
EMPTY . 0
TEAM_A a 1
TEAM_B b 2
BARRIER # 3
A grid is supposedly a set of lines composed of the aforementionned
characters, for illustration, a Boad like the following:
const board = [[3, 3, 3, 3, 3, 3, 3, 3, 3],
[3, 0, 1, 0, 0, 0, 0, 2, 3],
[3, 0, 1, 0, 1, 2, 2, 2, 3],
[3, 0, 0, 1, 1, 2, 1, 1, 3],
[3, 0, 0, 0, 2, 2, 2, 0, 3],
[3, 3, 3, 3, 3, 3, 3, 3, 3]]; // 9x6
will be represented in the following file:
(file: //.../board.l2tf)
#########\n
#.a....b#\n
#.a.abbb#\n
#..aabaa#\n
#...bbb.#\n
#########\n
The current implementation, in JavaScript, exposes only three elements:
two functions and a string-based C-like enumeration.
The API is really simple, only being based on the parse() and
stringify() methods. JavaScript experts may recognize a similar pattern
as the standard JSON API available.
A typical user flow of the system may be:
import * as Life2 from '@life2/game';
import * as L2TF from '@life2/format';
const game = new Life2.World(...);
// ... init game
// Save the current board state in a file to share it with others
const curr = game.board.getGrid();
const text = L2TF.stringify(curr);
shareFile(new File(text));
Signed-off-by: Nicolas Paul <n@nc0.fr>
| -rw-r--r-- | life2/format/LICENSE | 202 | ||||
| -rw-r--r-- | life2/format/README.md | 0 | ||||
| -rw-r--r-- | life2/format/index.js | 94 | ||||
| -rw-r--r-- | life2/format/package.json | 47 | ||||
| -rw-r--r-- | package-lock.json | 155 | ||||
| -rw-r--r-- | package.json | 4 |
6 files changed, 439 insertions, 63 deletions
diff --git a/life2/format/LICENSE b/life2/format/LICENSE new file mode 100644 index 0000000..7a4a3ea --- /dev/null +++ b/life2/format/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License.
\ No newline at end of file diff --git a/life2/format/README.md b/life2/format/README.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/life2/format/README.md diff --git a/life2/format/index.js b/life2/format/index.js new file mode 100644 index 0000000..82fe8b2 --- /dev/null +++ b/life2/format/index.js @@ -0,0 +1,94 @@ +/** + * Copyright 2024 The Life2 Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * @license + */ + +/** + * @fileoverview A JavaScript implementation of the Life2 Text Format, to be + * used by applications with the @life2/game module to share and import game + * data. + * + * The Life2 Text Format, often abbreviated as L2TF, us a simple ASCII-based + * file format to represent a grid at a certain state/generation, allowing the + * sharing of game data between different applications. + * An illustration of a use-cse would be a user creating a game in a simulation, + * discovering it leads to a certain pattern, and then sharing the game data + * with other users, who can then import the game data into their own + * simulations and see for themselves the pattern. + * + * @package format + */ + +import {Cell, Grid} from '@life2/game'; + +/** + * The characters used to represent cells in the Life2 Text Format. + * @enum {string} + * @const + */ +export const TextCell = { + EMPTY: '.', + TEAM_A: 'a', + TEAM_B: 'b', + BARRIER: '#', +}; + +/** + * Parse a Life2 Text Format string into a grid. + * @param {string} string The Life2 Text Format string to parse. + * @return {!Grid} The grid represented by the input string. + * @throws {Error} If the input string is not a valid Life2 Text Format string. + */ +export function parse(string) { + const parseCell = (char) => { + switch (char) { + case TextCell.EMPTY: + return Cell.EMPTY; + case TextCell.TEAM_A: + return Cell.TEAM_A; + case TextCell.TEAM_B: + return Cell.TEAM_B; + case TextCell.BARRIER: + return Cell.BARRIER; + default: + throw new Error('Invalid character'); + } + }; + return string.split('\n').map((row) => row.split('').map(parseCell)); +} + +/** + * Convert a grid into a Life2 Text Format string. + * @param {!Grid} grid The grid to convert. + * @return {string} The Life2 Text Format string representing the input grid. + * @throws {Error} If the input grid is not a valid grid. + */ +export function stringify(grid) { + const stringifyCell = (cell) => { + switch (cell) { + case Cell.EMPTY: + return TextCell.EMPTY; + case Cell.TEAM_A: + return TextCell.TEAM_A; + case Cell.TEAM_B: + return TextCell.TEAM_B; + case Cell.BARRIER: + return TextCell.BARRIER; + default: + throw new Error('Invalid cell'); + } + }; + return grid.map((row) => row.map(stringifyCell).join('')).join('\n'); +} diff --git a/life2/format/package.json b/life2/format/package.json new file mode 100644 index 0000000..506eded --- /dev/null +++ b/life2/format/package.json @@ -0,0 +1,47 @@ +{ + "name": "@life2/format", + "version": "1.0.0", + "description": "Textual representation format of a Life2 board state.", + "keywords": [ + "cellular", + "automaton", + "game", + "life" + ], + "homepage": "https://github.com/nc0fr/life2/tree/master/life2/format#readme", + "bugs": { + "url": "https://github.com/nc0fr/life2/issues", + "email": "n@nc0.fr" + }, + "license": "Apache-2.0", + "author": "The Life2 Authors", + "contributors": [ + "Nicolas Paul <n@nc0.fr> (https://nc0.fr)" + ], + "funding": { + "type": "individual", + "url": "https://github.com/sponsors/nc0fr" + }, + "browser": true, + "repository": { + "type": "git", + "url": "https://github.com/nc0fr/life2.git", + "directory": "life2/format" + }, + "files": [ + "LICENSE", + "README.md", + "index.js" + ], + "main": "./index.js", + "readme": "README.md", + "scripts": { + "lint": "eslint .", + "lint-fix": "eslint --fix .", + "fmt": "clang-format -i *.js", + "fmt-check": "clang-format --dry-run --Werror *.js" + }, + "dependencies": { + "@life2/game": "1.0.0" + } +} diff --git a/package-lock.json b/package-lock.json index d1d9e28..a4c63c2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,9 @@ "version": "0.0.1", "license": "Apache-2.0", "workspaces": [ - "life2/simulator" + "life2/simulator", + "life2/game", + "life2/format" ], "devDependencies": { "eslint": "8.57.0", @@ -17,6 +19,27 @@ "jsdoc": "4.0.2" } }, + "life2/format": { + "name": "@life2/format", + "version": "1.0.0", + "license": "Apache-2.0", + "dependencies": { + "@life2/game": "1.0.0" + }, + "funding": { + "type": "individual", + "url": "https://github.com/sponsors/nc0fr" + } + }, + "life2/game": { + "name": "@life2/game", + "version": "1.0.0", + "license": "Apache-2.0", + "funding": { + "type": "individual", + "url": "https://github.com/sponsors/nc0fr" + } + }, "life2/simulator": { "name": "@nc0/life2-simulator", "version": "1.0.0", @@ -148,6 +171,14 @@ "node": ">=v12.0.0" } }, + "node_modules/@life2/format": { + "resolved": "life2/format", + "link": true + }, + "node_modules/@life2/game": { + "resolved": "life2/game", + "link": true + }, "node_modules/@nc0/life2-simulator": { "resolved": "life2/simulator", "link": true @@ -1266,67 +1297,6 @@ "node": ">=4.0" } }, - "node_modules/eslint/node_modules/find-up": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", - "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==", - "dev": true, - "dependencies": { - "locate-path": "^6.0.0", - "path-exists": "^4.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/eslint/node_modules/locate-path": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", - "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==", - "dev": true, - "dependencies": { - "p-locate": "^5.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/eslint/node_modules/p-limit": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", - "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", - "dev": true, - "dependencies": { - "yocto-queue": "^0.1.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/eslint/node_modules/p-locate": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-5.0.0.tgz", - "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==", - "dev": true, - "dependencies": { - "p-limit": "^3.0.2" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/esniff": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/esniff/-/esniff-2.0.1.tgz", @@ -1521,6 +1491,22 @@ "node": "^10.12.0 || >=12.0.0" } }, + "node_modules/find-up": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", + "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==", + "dev": true, + "dependencies": { + "locate-path": "^6.0.0", + "path-exists": "^4.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/flat-cache": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.2.0.tgz", @@ -2154,6 +2140,21 @@ "uc.micro": "^1.0.1" } }, + "node_modules/locate-path": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", + "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==", + "dev": true, + "dependencies": { + "p-locate": "^5.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/lodash": { "version": "4.17.21", "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", @@ -2344,6 +2345,36 @@ "node": ">=0.10.0" } }, + "node_modules/p-limit": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", + "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", + "dev": true, + "dependencies": { + "yocto-queue": "^0.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-locate": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-5.0.0.tgz", + "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==", + "dev": true, + "dependencies": { + "p-limit": "^3.0.2" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/parent-module": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", diff --git a/package.json b/package.json index b9fff31..4a5f59f 100644 --- a/package.json +++ b/package.json @@ -13,7 +13,9 @@ }, "homepage": "https://github.com/nc0fr/life2#readme", "workspaces": [ - "life2/simulator" + "life2/simulator", + "life2/game", + "life2/format" ], "scripts": { "lint": "eslint .", |
