diff options
| -rw-r--r-- | .editorconfig | 4 | ||||
| -rw-r--r-- | .vscode/settings.json | 8 | ||||
| -rw-r--r-- | AUTHORS | 36 | ||||
| -rw-r--r-- | COPYRIGHT | 1 | ||||
| -rw-r--r-- | LICENSE | 202 | ||||
| -rw-r--r-- | NOTICE | 4 | ||||
| -rw-r--r-- | README | 10 | ||||
| l--------- | life2/simulator/COPYRIGHT | 1 | ||||
| -rw-r--r-- | life2/simulator/README | 8 | ||||
| -rw-r--r-- | life2/simulator/package.json | 5 | ||||
| -rw-r--r-- | life2/simulator/src/game/world.js | 136 | ||||
| -rw-r--r-- | package-lock.json | 6 | ||||
| -rw-r--r-- | package.json | 24 |
13 files changed, 377 insertions, 68 deletions
diff --git a/.editorconfig b/.editorconfig index 1b5b392..0b1ec0c 100644 --- a/.editorconfig +++ b/.editorconfig @@ -21,10 +21,6 @@ indent_style = tab indent_size = 2 indent_style = space -[*.go] -indent_size = 8 -indent_style = tab - [*.py] indent_size = 4 indent_style = space diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..ae059e6 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,8 @@ +{ + "files.associations": { + "README": "plaintext", + "LICENSE": "plaintext", + "AUTHORS": "plaintext", + "NOTICE": "plaintext" + } +}
\ No newline at end of file @@ -1,28 +1,14 @@ -This file lists the various contributors to the project. Anyone listed here -remains the copyright holder of their contributions, and is listed here to -acknowledge their work. - -Both individuals and organizations may be listed here. Either way, we require -using the full legal name of the contributor, and not any pseudonyms or -abbreviations. We also ask to include all the EMail addresses used to commit -patches, each within angle brackets. - -If you are a contributor and would like to be removed from this list, please -contact the project maintainers. - -When adding a new entry, please keep the list sorted by the first name, this -may be easily achieved using the sort command on UNIX systems. - -For illustration: - -John Doe <john@doe.com> -Acme Corporation <usr1@ac.me> <usr2@ac.me> - -ALL CONTRIBUTORS LISTED BELOW HAVE AGREED TO THE PROJECT LICENSE AGREEMENT -AVAILABLE IN THE COPYRIGHT FILE. - - *** - +# The official list of the project authors for copyright purposes. + +# Names should be listed using the full name (no pseudonyms and anonymous +# contributions, sorry), followed by an Email address in angle brackets. +# The full name may be an organization, in which case the Email address is +# not necessary. +# +# For example: +# +# John Doe <john@doe.com> +# Acme Corporation Ltd. Nicolas Paul <n@nc0.fr> Nathan Rissot <nathan.rissot@gmail.com> diff --git a/COPYRIGHT b/COPYRIGHT deleted file mode 100644 index c865b50..0000000 --- a/COPYRIGHT +++ /dev/null @@ -1 +0,0 @@ -Copyright (c) 2024 The Life 2 Authors. All rights reserved. @@ -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 @@ -0,0 +1,4 @@ +Life2 +Copyright (c) 2024 The Life2 Authors. + +This product includes software developed by The Life2 Authors.
\ No newline at end of file @@ -30,12 +30,4 @@ LIFE2 peuvent se cacher des mathématiques." de la licence informatique de l'UFR Sciences et Techniques de l'Université d'Orléans [1]. - [1]: https://www.univ-orleans.fr/fr/sciences-techniques - - -COPYRIGHT - - L'intégralité du projet est la propriété de ses auteurs. Toute reproduction - non-autorisée est strictement interdite par la loi. - - Copyright (c) 2024 The Life 2 Authors. All rights reserved. + [1]: https://www.univ-orleans.fr/fr/sciences-techniques
\ No newline at end of file diff --git a/life2/simulator/COPYRIGHT b/life2/simulator/COPYRIGHT deleted file mode 120000 index 8b0161c..0000000 --- a/life2/simulator/COPYRIGHT +++ /dev/null @@ -1 +0,0 @@ -../../COPYRIGHT
\ No newline at end of file diff --git a/life2/simulator/README b/life2/simulator/README index 77ab8b4..5843682 100644 --- a/life2/simulator/README +++ b/life2/simulator/README @@ -19,11 +19,3 @@ SIMULATOR LIFE2 Simulator est une application faisant partie du projet Life 2. - - -COPYRIGHT - - L'intégralité du projet est la propriété de ses auteurs. Toute reproduction - non-autorisée est strictement interdite par la loi. - - Copyright (c) 2024 The Life 2 Authors. All rights reserved. diff --git a/life2/simulator/package.json b/life2/simulator/package.json index 349ed00..a366905 100644 --- a/life2/simulator/package.json +++ b/life2/simulator/package.json @@ -17,7 +17,7 @@ "url": "https://github.com/nc0fr/life2/issues", "email": "n@nc0.fr" }, - "license": "SEE LICENSE IN COPYRIGHT", + "license": "Apache-2.0", "author": "Nicolas Paul <n@nc0.fr> (https://nc0.fr)", "funding": { "type": "individual", @@ -33,7 +33,10 @@ "test": "echo \"Error: no test specified\" && exit 1" }, "devDependencies": { +<<<<<<< HEAD +======= "typescript": "5.3.3", +>>>>>>> 2ec513dd3a4e416d1acf3e8c573f52896d1bf764 "webpack": "5.90.3", "webpack-cli": "5.1.4" } diff --git a/life2/simulator/src/game/world.js b/life2/simulator/src/game/world.js new file mode 100644 index 0000000..850aaa1 --- /dev/null +++ b/life2/simulator/src/game/world.js @@ -0,0 +1,136 @@ +/** + * 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 + */ + +/** + * The possible states of a cell in the world. + * @readonly + * @enum {string} + */ +export const CELL_STATES = { + /** The cell is empty, possible because it never was filled or it died. */ + EMPTY: ".", + /** The cell is occupied by a member of team A. */ + TEAM_A: "a", + /** The cell is occupied by a member of team B. */ + TEAM_B: "b", + /** The cell is a barrier, and it cannot be occupied by any entity, + * nor can it be modified by rules. */ + BARRIER: "#", +}; + +/** + * A board is an array of strings, where each string represents a row of the + * board, and each character in the string represents a cell in the row. + * @typedef {Array<CELL_STATES>} Board + */ + +/** + * The representation of the world, where all the entities live, and where the + * simulation takes place. + */ +export class World { + /** + * Create a new world with the given width and height. + * @constructor + * @param {number} width - The width of the world. + * @param {number} height - The height of the world. + */ + constructor(width, height) { + // TODO(nc0) Support different types of boards, not just 2D + + /** + * The width of the world board. + * @type {number} + * @readonly + */ + this.width = width; + /** + * The height of the world board. + * @type {number} + * @readonly + */ + this.height = height; + /** + * The board of the world, where all the entities live. + * @type {Board} + * @private + */ + this.board = this.newBoard(width, height); + } + + /** + * Create a new board with the given width and height, initializing all + * the cells to be empty. + * @param {number} width - The width of the board. + * @param {number} height - The height of the board. + * @returns {Board} The new board. + */ + newBoard(width, height) { + return new Array(width).fill(CELL_STATES.EMPTY.repeat(height)); + } + + /** + * Returns the cell at the given coordinates. + * @param {number} x - The x coordinate of the cell. + * @param {number} y - The y coordinate of the cell. + * @returns {CELL_STATES | null} The cell at the given coordinates, + * or null if the coordinates are out of bounds. + */ + getCell(x, y) { + if (x < 0 || x > this.width || + y < 0 || y > this.height) return null; + + return this.board[x][y]; + } + + /** + * Returns the cells that are adjacent to the given coordinates. + * @param {number} x - The x coordinate of the cell. + * @param {number} y - The y coordinate of the cell. + * @returns {Array<(number, number)>} The cells that are adjacent to the given + * coordinates. + */ + getNeighbors(x, y) { + // TODO(nc0): Avoid hardcoding the 8 neighbors, check the bounds, ... + return [(x - 1, y - 1), (x, y - 1), (x + 1, y - 1), + (x - 1, y), /* (x, y) */ (x + 1, y), + (x - 1, y + 1), (x, y + 1), (x + 1, y + 1)] + .filter((x, y) => this.getCell(x, y) !== null); + } + + /** + * + */ + nextState() { + // TODO(nc0): Implement various rules for the next state + const newBoard = this.newBoard(this.width, this.height); + + for (let x = 0; x < this.width; x++) { + for (let y = 0; y < this.height; y++) { + const cell = this.getCell(x, y); + const neighbors = this.getNeighbors(x, y); + neighbors; + + // Apply the rules to the cell and its neighbors + // and update the new board + newBoard[x][y] = cell; + } + } + + this.board = newBoard; + } +} diff --git a/package-lock.json b/package-lock.json index 3ca4139..c9f399c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -21,7 +21,10 @@ "version": "1.0.0", "license": "SEE LICENSE IN COPYRIGHT", "devDependencies": { +<<<<<<< HEAD +======= "typescript": "5.3.3", +>>>>>>> 2ec513dd3a4e416d1acf3e8c573f52896d1bf764 "webpack": "5.90.3", "webpack-cli": "5.1.4" }, @@ -1175,6 +1178,8 @@ } } }, +<<<<<<< HEAD +======= "node_modules/typescript": { "version": "5.3.3", "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.3.3.tgz", @@ -1188,6 +1193,7 @@ "node": ">=14.17" } }, +>>>>>>> 2ec513dd3a4e416d1acf3e8c573f52896d1bf764 "node_modules/undici-types": { "version": "5.26.5", "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz", diff --git a/package.json b/package.json index 2a5a57f..9a573b2 100644 --- a/package.json +++ b/package.json @@ -1,29 +1,15 @@ { "name": "@nc0/life2-workspace", - "version": "1.0.0", - "description": "Workspace for the Life 2 project", + "version": "0.0.1", + "description": "Workspace for the Life2 project", "private": true, - "license": "SEE LICENSE IN COPYRIGHT", - "packageManager": "npm@10.2.4", - "engines": { - "node": ">=20.11.1", - "npm": ">=10.2.4" - }, + "license": "Apache-2.0", "repository": { "type": "git", - "url": "git+https://github.com/nc0fr/life2.git" + "url": "https://github.com/nc0fr/life2.git" }, - "keywords": [ - "game", - "of", - "life", - "cellular", - "automate" - ], - "author": "Nicolas Paul <n@nc0.fr> (https://nc0.fr)", "bugs": { - "url": "https://github.com/nc0fr/life2/issues", - "email": "n@nc0.fr" + "url": "https://github.com/nc0fr/life2/issues" }, "homepage": "https://github.com/nc0fr/life2#readme", "workspaces": [ |