Setup mod metadata
This commit is contained in:
commit
a7d40e6419
2
.gitignore
vendored
Normal file
2
.gitignore
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
__pycache__
|
||||
*.DS_Store
|
122
.gitlab-ci.yml
Normal file
122
.gitlab-ci.yml
Normal file
@ -0,0 +1,122 @@
|
||||
check_templates_pr:
|
||||
image:
|
||||
name: $CI_REGISTRY_IMAGE:latest
|
||||
entrypoint: [""]
|
||||
stage: build
|
||||
only:
|
||||
refs:
|
||||
- merge_requests
|
||||
script:
|
||||
- git fetch origin main
|
||||
- files="$(git diff-tree --no-commit-id --name-only -r HEAD origin/$CI_DEFAULT_BRANCH)"
|
||||
- files="$(echo $files | grep 'simulation/templates/' | grep '.xml' || true)"
|
||||
- files=$(echo "$files" | awk '{ gsub("community-mod/","", $0); print $0 }')
|
||||
- "[ -z $files ] && echo 'Nothing to check' || $(python3 -m scripts.entvalidate -p $files)"
|
||||
|
||||
check_templates_all:
|
||||
image:
|
||||
name: $CI_REGISTRY_IMAGE:latest
|
||||
entrypoint: [""]
|
||||
stage: build
|
||||
only:
|
||||
refs:
|
||||
- main
|
||||
changes:
|
||||
- community-mod/**/*
|
||||
script:
|
||||
- python3 -m scripts.entvalidate
|
||||
|
||||
check_version_increment:
|
||||
stage: deploy
|
||||
when: manual
|
||||
allow_failure: false
|
||||
rules:
|
||||
- if: $CI_COMMIT_BRANCH == "main"
|
||||
- if: $CI_COMMIT_BRANCH == "signed"
|
||||
script:
|
||||
- VERSION=$(python3 -m scripts.get_version)
|
||||
- git tag -l
|
||||
- git tag -l $VERSION
|
||||
- "[ -z $(git tag -l $VERSION) ] || exit 1 "
|
||||
|
||||
package_mod_job:
|
||||
image:
|
||||
name: "$CI_REGISTRY/0ad/0ad-community-mod-a26/pyrogenesis:0.25.0"
|
||||
stage: deploy
|
||||
rules:
|
||||
- if: $CI_COMMIT_BRANCH == "main"
|
||||
- if: $CI_COMMIT_BRANCH == "signed"
|
||||
needs:
|
||||
- job: check_version_increment
|
||||
artifacts:
|
||||
paths:
|
||||
- community-mod.zip
|
||||
reports:
|
||||
dotenv: build.env
|
||||
script:
|
||||
- VERSION=$(python3 -m scripts.get_version)
|
||||
- echo "VERSION=${VERSION}" >> build.env
|
||||
- /usr/games/0ad -archivebuild=community-mod -archivebuild-output=community-mod.zip
|
||||
|
||||
store_mod:
|
||||
rules:
|
||||
- if: $CI_COMMIT_BRANCH == "main"
|
||||
- if: $CI_COMMIT_BRANCH == "signed"
|
||||
image: curlimages/curl:latest
|
||||
stage: deploy
|
||||
needs:
|
||||
- job: package_mod_job
|
||||
artifacts: true
|
||||
script:
|
||||
- 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file community-mod.zip "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/community-mod/${VERSION}/community-mod.zip"'
|
||||
|
||||
release_job:
|
||||
stage: deploy
|
||||
image: registry.gitlab.com/gitlab-org/release-cli:latest
|
||||
needs:
|
||||
- job: store_mod
|
||||
- job: package_mod_job
|
||||
artifacts: true
|
||||
rules:
|
||||
- if: $CI_COMMIT_BRANCH == "main"
|
||||
- if: $CI_COMMIT_BRANCH == "signed"
|
||||
script:
|
||||
- echo "running release_job for $TAG"
|
||||
release:
|
||||
name: 'Community Mod $VERSION'
|
||||
description: 'Version $VERSION of the 0 A.D. community mod for A26'
|
||||
tag_name: '$VERSION'
|
||||
ref: '$CI_COMMIT_SHA'
|
||||
assets:
|
||||
links:
|
||||
- name: 'community-mod.zip'
|
||||
url: '${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/community-mod/${VERSION}/community-mod.zip'
|
||||
|
||||
sign_and_upload_to_modio:
|
||||
stage: deploy
|
||||
image:
|
||||
name: $CI_REGISTRY_IMAGE:latest
|
||||
entrypoint: [""]
|
||||
rules:
|
||||
- if: $CI_COMMIT_BRANCH == "signed"
|
||||
when: manual
|
||||
script:
|
||||
- ls
|
||||
- VERSION=$(python3 -m scripts.get_version)
|
||||
- wget "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/community-mod/${VERSION}/community-mod.zip" -O "0ad-community-mod-${VERSION}.zip"
|
||||
- echo $MINISIGN_KEY_PW | minisign -S -s $MINISIGN_KEY -m "0ad-community-mod-${VERSION}.zip" -x signature.minisign
|
||||
- MOD_FILE_PATH="0ad-community-mod-${VERSION}.zip" MOD_VERSION="$VERSION" python3 -m scripts.modio
|
||||
|
||||
build_docker_image:
|
||||
image: docker:19.03.12
|
||||
rules:
|
||||
- if: $CI_COMMIT_BRANCH == "signed"
|
||||
when: manual
|
||||
stage: build
|
||||
services:
|
||||
- docker:19.03.12-dind
|
||||
script:
|
||||
- docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
|
||||
- docker build -t $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG -t $CI_REGISTRY_IMAGE:latest .
|
||||
- docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG
|
||||
- docker push $CI_REGISTRY_IMAGE:latest
|
11
.gitlab/issue_templates/Default.md
Normal file
11
.gitlab/issue_templates/Default.md
Normal file
@ -0,0 +1,11 @@
|
||||
## Summary
|
||||
|
||||
(Summarize the issue. You may also refer to earlier commits.)
|
||||
|
||||
## Possible Fixes
|
||||
|
||||
(Suggest ways that this could be fixed.)
|
||||
|
||||
## Replays
|
||||
|
||||
(If relevant, provide replays of 0 A.D. games showing your issue.)
|
7
.gitlab/merge_request_templates/Default.md
Normal file
7
.gitlab/merge_request_templates/Default.md
Normal file
@ -0,0 +1,7 @@
|
||||
## Summary
|
||||
|
||||
(Summarize the changes)
|
||||
|
||||
## Rationale
|
||||
|
||||
(Justify the change, possibly highlight risks)
|
11
Dockerfile
Normal file
11
Dockerfile
Normal file
@ -0,0 +1,11 @@
|
||||
# Start from git because we need to fetch modified files.
|
||||
# Older version or python 3.9 breaks.
|
||||
FROM alpine/git:v2.34.2
|
||||
|
||||
# Install python3 xlmlint so we can run the entvalidate script.
|
||||
RUN apk add python3~=3.9 libxml2-utils
|
||||
|
||||
# Required for mod IO upload & signing.
|
||||
RUN apk add minisign && python3 -m ensurepip && pip3 install --no-cache-dir requests
|
||||
|
||||
ENTRYPOINT ["sh"]
|
11
Dockerfile-0ad
Normal file
11
Dockerfile-0ad
Normal file
@ -0,0 +1,11 @@
|
||||
FROM debian:sid
|
||||
|
||||
RUN apt update && apt install 0ad-data -y && rm -rf /usr/share/games/0ad/mods/public
|
||||
|
||||
RUN apt update && apt install 0ad -y
|
||||
|
||||
RUN apt install python3 -y
|
||||
|
||||
# Cannot run 0 A.D. as root.
|
||||
RUN useradd -ms /bin/sh nonrootuser
|
||||
USER nonrootuser
|
10
LICENSE.txt
Normal file
10
LICENSE.txt
Normal file
@ -0,0 +1,10 @@
|
||||
0 A.D. Licensing Details
|
||||
==========================
|
||||
|
||||
0 A.D. is released as open source: you can freely use, copy, modify and
|
||||
distribute the game's source code and data files, as long as you include
|
||||
attribution to Wildfire Games and let anyone freely modify and distribute any
|
||||
of your own modifications to the game's files.
|
||||
|
||||
All files in the current repository are release under GPL version 2 (or later).
|
||||
See license_gpl-2.0.txt
|
47
README.md
Normal file
47
README.md
Normal file
@ -0,0 +1,47 @@
|
||||
# 0 A.D. Community mod for Alpha 26 Zhuangzi [![Latest Release](https://gitlab.com/wraitii/0ad-community-mod-a26/-/badges/release.svg)](https://gitlab.com/wraitii/0ad-community-mod-a26/-/releases)
|
||||
|
||||
This is a community-powered mod for 0 A.D.'s alpha 26, officially supported by the core team. The intention is to make it possible to improve the A26 gameplay experience, particularly MP balance.
|
||||
The team wanted to give the community more power, and make it easier to contribute, thus this is hosted on gitlab and community members can request commit access.
|
||||
|
||||
## For maintainers with commit access
|
||||
|
||||
You are responsible for this mod. When rewiewing merge requests and changes, consider the following:
|
||||
- This is not intended as an overhaul mod but as tweaks on the A26 formula to make it more enjoyable.
|
||||
- Changes should be incremental so they can be play-tested.
|
||||
- You may want to merge risky changes, they can be reverted a bit later.
|
||||
- Feel free to ask the core team for support.
|
||||
|
||||
Please read 'releasing new versions' below as well.
|
||||
|
||||
## For contributors making merge requests
|
||||
|
||||
First of all, thanks for contributing to the mod. Please:
|
||||
- Be mindful of committer's time and energy.
|
||||
- Make small changes that can be easily reviewed.
|
||||
- Take this as a potential learning experience for the 0 A.D. gitlab migration in the future
|
||||
|
||||
## For players of the mod
|
||||
|
||||
Actually playing this mod is the key to sucess. Please:
|
||||
- Report on changes in the merge requests or open new issues.
|
||||
- Be respectful of other's work. Not every change will work as intended.
|
||||
|
||||
### Releasing new versions
|
||||
|
||||
The repository is setup so that increasing the version number in `mod.json` will create a new version of the mod that can be downloaded directly. Please do so at reasonable intervals, so that people can easily test the mod that way.
|
||||
|
||||
The 0 A.D. team will also attempt to sign versions regularly, releasing them on mod.io so that the mod remains reasonable up-to-date.
|
||||
|
||||
### Repository management
|
||||
|
||||
Anyone can make Merge Requests and suggest changes. Getting commit access is possible, but you will need to request it to the 0 A.D. core team. To avoid spam and keep things manageable, we reserve the right to grant / rescind commit access at any time.
|
||||
|
||||
### Scope
|
||||
|
||||
The mod starts out with the simulation `data/` and `templates/` folders.
|
||||
This makes it easier to change these files without copying anything explicitly.
|
||||
|
||||
It is possible to use the copy_files script to copy new files, if needed, e.g:
|
||||
`python3 -m scripts.copy_files -0ad="[path]" -p "maps/random"`
|
||||
|
||||
If you do add new files, please first add the unmodified file from A26 then apply your changes on top of it in a separate commit. This will make the reviewers' jobs much easier.
|
8
community-mod/mod.json
Normal file
8
community-mod/mod.json
Normal file
@ -0,0 +1,8 @@
|
||||
{
|
||||
"name": "community-mod",
|
||||
"version": "0.26.0",
|
||||
"label": "0 A.D. Community Mod",
|
||||
"url": "https://gitlab.com/wraitii/0ad-community-mod-a26",
|
||||
"description": "The Community Mod is a community-led effort to improve the gameplay of 0 A.D., officially backed by the 0 A.D. team.",
|
||||
"dependencies": ["0ad=0.0.26"]
|
||||
}
|
339
license_gpl-2.0.txt
Executable file
339
license_gpl-2.0.txt
Executable file
@ -0,0 +1,339 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 2, June 1991
|
||||
|
||||
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
License is intended to guarantee your freedom to share and change free
|
||||
software--to make sure the software is free for all its users. This
|
||||
General Public License applies to most of the Free Software
|
||||
Foundation's software and to any other program whose authors commit to
|
||||
using it. (Some other Free Software Foundation software is covered by
|
||||
the GNU Lesser General Public License instead.) You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
this service if you wish), that you receive source code or can get it
|
||||
if you want it, that you can change the software or use pieces of it
|
||||
in new free programs; and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
anyone to deny you these rights or to ask you to surrender the rights.
|
||||
These restrictions translate to certain responsibilities for you if you
|
||||
distribute copies of the software, or if you modify it.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must give the recipients all the rights that
|
||||
you have. You must make sure that they, too, receive or can get the
|
||||
source code. And you must show them these terms so they know their
|
||||
rights.
|
||||
|
||||
We protect your rights with two steps: (1) copyright the software, and
|
||||
(2) offer you this license which gives you legal permission to copy,
|
||||
distribute and/or modify the software.
|
||||
|
||||
Also, for each author's protection and ours, we want to make certain
|
||||
that everyone understands that there is no warranty for this free
|
||||
software. If the software is modified by someone else and passed on, we
|
||||
want its recipients to know that what they have is not the original, so
|
||||
that any problems introduced by others will not reflect on the original
|
||||
authors' reputations.
|
||||
|
||||
Finally, any free program is threatened constantly by software
|
||||
patents. We wish to avoid the danger that redistributors of a free
|
||||
program will individually obtain patent licenses, in effect making the
|
||||
program proprietary. To prevent this, we have made it clear that any
|
||||
patent must be licensed for everyone's free use or not licensed at all.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License applies to any program or other work which contains
|
||||
a notice placed by the copyright holder saying it may be distributed
|
||||
under the terms of this General Public License. The "Program", below,
|
||||
refers to any such program or work, and a "work based on the Program"
|
||||
means either the Program or any derivative work under copyright law:
|
||||
that is to say, a work containing the Program or a portion of it,
|
||||
either verbatim or with modifications and/or translated into another
|
||||
language. (Hereinafter, translation is included without limitation in
|
||||
the term "modification".) Each licensee is addressed as "you".
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running the Program is not restricted, and the output from the Program
|
||||
is covered only if its contents constitute a work based on the
|
||||
Program (independent of having been made by running the Program).
|
||||
Whether that is true depends on what the Program does.
|
||||
|
||||
1. You may copy and distribute verbatim copies of the Program's
|
||||
source code as you receive it, in any medium, provided that you
|
||||
conspicuously and appropriately publish on each copy an appropriate
|
||||
copyright notice and disclaimer of warranty; keep intact all the
|
||||
notices that refer to this License and to the absence of any warranty;
|
||||
and give any other recipients of the Program a copy of this License
|
||||
along with the Program.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy, and
|
||||
you may at your option offer warranty protection in exchange for a fee.
|
||||
|
||||
2. You may modify your copy or copies of the Program or any portion
|
||||
of it, thus forming a work based on the Program, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) You must cause the modified files to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
b) You must cause any work that you distribute or publish, that in
|
||||
whole or in part contains or is derived from the Program or any
|
||||
part thereof, to be licensed as a whole at no charge to all third
|
||||
parties under the terms of this License.
|
||||
|
||||
c) If the modified program normally reads commands interactively
|
||||
when run, you must cause it, when started running for such
|
||||
interactive use in the most ordinary way, to print or display an
|
||||
announcement including an appropriate copyright notice and a
|
||||
notice that there is no warranty (or else, saying that you provide
|
||||
a warranty) and that users may redistribute the program under
|
||||
these conditions, and telling the user how to view a copy of this
|
||||
License. (Exception: if the Program itself is interactive but
|
||||
does not normally print such an announcement, your work based on
|
||||
the Program is not required to print an announcement.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Program,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Program, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Program.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Program
|
||||
with the Program (or with a work based on the Program) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may copy and distribute the Program (or a work based on it,
|
||||
under Section 2) in object code or executable form under the terms of
|
||||
Sections 1 and 2 above provided that you also do one of the following:
|
||||
|
||||
a) Accompany it with the complete corresponding machine-readable
|
||||
source code, which must be distributed under the terms of Sections
|
||||
1 and 2 above on a medium customarily used for software interchange; or,
|
||||
|
||||
b) Accompany it with a written offer, valid for at least three
|
||||
years, to give any third party, for a charge no more than your
|
||||
cost of physically performing source distribution, a complete
|
||||
machine-readable copy of the corresponding source code, to be
|
||||
distributed under the terms of Sections 1 and 2 above on a medium
|
||||
customarily used for software interchange; or,
|
||||
|
||||
c) Accompany it with the information you received as to the offer
|
||||
to distribute corresponding source code. (This alternative is
|
||||
allowed only for noncommercial distribution and only if you
|
||||
received the program in object code or executable form with such
|
||||
an offer, in accord with Subsection b above.)
|
||||
|
||||
The source code for a work means the preferred form of the work for
|
||||
making modifications to it. For an executable work, complete source
|
||||
code means all the source code for all modules it contains, plus any
|
||||
associated interface definition files, plus the scripts used to
|
||||
control compilation and installation of the executable. However, as a
|
||||
special exception, the source code distributed need not include
|
||||
anything that is normally distributed (in either source or binary
|
||||
form) with the major components (compiler, kernel, and so on) of the
|
||||
operating system on which the executable runs, unless that component
|
||||
itself accompanies the executable.
|
||||
|
||||
If distribution of executable or object code is made by offering
|
||||
access to copy from a designated place, then offering equivalent
|
||||
access to copy the source code from the same place counts as
|
||||
distribution of the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
4. You may not copy, modify, sublicense, or distribute the Program
|
||||
except as expressly provided under this License. Any attempt
|
||||
otherwise to copy, modify, sublicense or distribute the Program is
|
||||
void, and will automatically terminate your rights under this License.
|
||||
However, parties who have received copies, or rights, from you under
|
||||
this License will not have their licenses terminated so long as such
|
||||
parties remain in full compliance.
|
||||
|
||||
5. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Program or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Program (or any work based on the
|
||||
Program), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Program or works based on it.
|
||||
|
||||
6. Each time you redistribute the Program (or any work based on the
|
||||
Program), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute or modify the Program subject to
|
||||
these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties to
|
||||
this License.
|
||||
|
||||
7. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Program at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Program by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Program.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under
|
||||
any particular circumstance, the balance of the section is intended to
|
||||
apply and the section as a whole is intended to apply in other
|
||||
circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system, which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
8. If the distribution and/or use of the Program is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Program under this License
|
||||
may add an explicit geographical distribution limitation excluding
|
||||
those countries, so that distribution is permitted only in or among
|
||||
countries not thus excluded. In such case, this License incorporates
|
||||
the limitation as if written in the body of this License.
|
||||
|
||||
9. The Free Software Foundation may publish revised and/or new versions
|
||||
of the General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program
|
||||
specifies a version number of this License which applies to it and "any
|
||||
later version", you have the option of following the terms and conditions
|
||||
either of that version or of any later version published by the Free
|
||||
Software Foundation. If the Program does not specify a version number of
|
||||
this License, you may choose any version ever published by the Free Software
|
||||
Foundation.
|
||||
|
||||
10. If you wish to incorporate parts of the Program into other free
|
||||
programs whose distribution conditions are different, write to the author
|
||||
to ask for permission. For software which is copyrighted by the Free
|
||||
Software Foundation, write to the Free Software Foundation; we sometimes
|
||||
make exceptions for this. Our decision will be guided by the two goals
|
||||
of preserving the free status of all derivatives of our free software and
|
||||
of promoting the sharing and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
||||
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
||||
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
||||
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
||||
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
||||
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
||||
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
||||
REPAIR OR CORRECTION.
|
||||
|
||||
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
||||
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
||||
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
||||
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
||||
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
||||
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License along
|
||||
with this program; if not, write to the Free Software Foundation, Inc.,
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program is interactive, make it output a short notice like this
|
||||
when it starts in an interactive mode:
|
||||
|
||||
Gnomovision version 69, Copyright (C) year name of author
|
||||
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, the commands you use may
|
||||
be called something other than `show w' and `show c'; they could even be
|
||||
mouse-clicks or menu items--whatever suits your program.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
||||
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
||||
|
||||
<signature of Ty Coon>, 1 April 1989
|
||||
Ty Coon, President of Vice
|
||||
|
||||
This General Public License does not permit incorporating your program into
|
||||
proprietary programs. If your program is a subroutine library, you may
|
||||
consider it more useful to permit linking proprietary applications with the
|
||||
library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License.
|
16
scripts/__init__.py
Normal file
16
scripts/__init__.py
Normal file
@ -0,0 +1,16 @@
|
||||
import json
|
||||
from pathlib import Path
|
||||
|
||||
MOD_PATH = Path("community-mod")
|
||||
|
||||
def check_cwd_is_correct():
|
||||
cwd = Path().resolve()
|
||||
try:
|
||||
if not Path(".git").exists():
|
||||
raise Exception("No .git in current folder.")
|
||||
with open(MOD_PATH / "mod.json", "r") as f:
|
||||
mod = json.load(f)
|
||||
if mod['name'] != "community-mod":
|
||||
raise Exception("mod.json has incorrect name")
|
||||
except:
|
||||
raise Exception("scripts.py must be called from the community mod repository")
|
42
scripts/copy_files.py
Executable file
42
scripts/copy_files.py
Executable file
@ -0,0 +1,42 @@
|
||||
import argparse
|
||||
import shutil
|
||||
from pathlib import Path
|
||||
from . import MOD_PATH, check_cwd_is_correct
|
||||
|
||||
PUBLIC_PATH = Path("binaries/data/mods/public/")
|
||||
|
||||
DEFAULT_COPY = [
|
||||
"simulation/data",
|
||||
"simulation/templates"
|
||||
]
|
||||
|
||||
def validate_path(path: str):
|
||||
mod_path = Path(path) / PUBLIC_PATH
|
||||
try:
|
||||
with open(mod_path / "mod.json", "r") as f:
|
||||
mod = json.load(f)
|
||||
if mod['name'] != "0ad":
|
||||
raise Exception("mod.json has incorrect name")
|
||||
except:
|
||||
raise Exception(f"path '{path}' does not point to a 0 A.D. SVN folder.")
|
||||
return mod_path
|
||||
|
||||
|
||||
def copy_0ad_files(path_0ad: Path, to_copy = DEFAULT_COPY):
|
||||
for path in to_copy:
|
||||
shutil.copytree(path_0ad / path, MOD_PATH / path, dirs_exist_ok=False)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
parser = argparse.ArgumentParser(description='Copy files from 0 A.D. to the community mod.')
|
||||
parser.add_argument('-0ad', help='Path to the 0 A.D. folder')
|
||||
parser.add_argument('-p','--path', nargs='*', help='Optionally, a list of paths to copy.')
|
||||
|
||||
args = parser.parse_args()
|
||||
|
||||
check_cwd_is_correct()
|
||||
path = validate_path(getattr(args, '0ad'))
|
||||
copy_0ad_files(path, args.folder or DEFAULT_COPY)
|
||||
else:
|
||||
raise Exception("Must be called directly")
|
||||
|
5000
scripts/entity.rng
Normal file
5000
scripts/entity.rng
Normal file
File diff suppressed because it is too large
Load Diff
57
scripts/entvalidate.py
Normal file
57
scripts/entvalidate.py
Normal file
@ -0,0 +1,57 @@
|
||||
#!/usr/bin/env python3
|
||||
import argparse
|
||||
from os import chdir
|
||||
from pathlib import Path
|
||||
from subprocess import run, CalledProcessError
|
||||
from sys import exit
|
||||
from xml.etree import ElementTree
|
||||
from .scriptlib import SimulTemplateEntity, find_files
|
||||
import logging
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
root = Path()
|
||||
relaxng_schema = root / "scripts" / "entity.rng"
|
||||
vfs_root = root
|
||||
mod = "community-mod"
|
||||
|
||||
def main():
|
||||
if not relaxng_schema.exists():
|
||||
print(f"""Relax NG schema non existant.
|
||||
Please create the file {relaxng_schema.relative_to(root)}
|
||||
You can do that by running 'pyrogenesis -dumpSchema' in the 'system' directory""")
|
||||
exit(1)
|
||||
if run(['xmllint', '--version'], capture_output=True).returncode != 0:
|
||||
print("xmllint not found in your PATH, please install it (usually in libxml2 package)")
|
||||
exit(2)
|
||||
|
||||
parser = argparse.ArgumentParser(description='Validate templates')
|
||||
parser.add_argument('-p','--path', nargs='*', help='Optionally, a list of templates to validate.')
|
||||
args = parser.parse_args()
|
||||
|
||||
simul_templates_path = Path('simulation/templates')
|
||||
simul_template_entity = SimulTemplateEntity(vfs_root, logger)
|
||||
count = 0
|
||||
failed = 0
|
||||
templates = sorted([(Path(p), None) for p in args.path]) if args.path else sorted(find_files(vfs_root, [mod], 'simulation/templates', 'xml'))
|
||||
for fp, _ in templates:
|
||||
if fp.stem.startswith('template_'):
|
||||
continue
|
||||
path = fp.as_posix()
|
||||
if path.startswith('simulation/templates/mixins/') or path.startswith("simulation/templates/special/"):
|
||||
continue
|
||||
print(f"# {fp}...")
|
||||
count += 1
|
||||
entity = simul_template_entity.load_inherited(simul_templates_path, str(fp.relative_to(simul_templates_path)), [mod])
|
||||
xmlcontent = ElementTree.tostring(entity, encoding='unicode')
|
||||
try:
|
||||
run(['xmllint', '--relaxng', str(relaxng_schema.resolve()), '-'], input=xmlcontent, capture_output=True, text=True, check=True)
|
||||
except CalledProcessError as e:
|
||||
failed += 1
|
||||
print(e.stderr)
|
||||
print(e.stdout)
|
||||
print(f"\nTotal: {count}; failed: {failed}")
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
13
scripts/get_version.py
Normal file
13
scripts/get_version.py
Normal file
@ -0,0 +1,13 @@
|
||||
import json
|
||||
from . import MOD_PATH, check_cwd_is_correct
|
||||
|
||||
def get_version():
|
||||
with open(MOD_PATH / "mod.json", "r") as f:
|
||||
mod = json.load(f)
|
||||
print(mod['version'])
|
||||
|
||||
if __name__ == '__main__':
|
||||
check_cwd_is_correct()
|
||||
get_version()
|
||||
else:
|
||||
raise Exception("Must be called directly")
|
14
scripts/make_pyromod.py
Normal file
14
scripts/make_pyromod.py
Normal file
@ -0,0 +1,14 @@
|
||||
import shutil
|
||||
from pathlib import Path
|
||||
from . import MOD_PATH, check_cwd_is_correct
|
||||
|
||||
|
||||
def make_pyromod():
|
||||
shutil.make_archive(MOD_PATH, 'zip', MOD_PATH)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
check_cwd_is_correct()
|
||||
make_pyromod()
|
||||
else:
|
||||
raise Exception("Must be called directly")
|
44
scripts/modio.py
Normal file
44
scripts/modio.py
Normal file
@ -0,0 +1,44 @@
|
||||
import json
|
||||
import os
|
||||
import requests
|
||||
|
||||
from . import MOD_PATH
|
||||
|
||||
api_key = os.getenv('MODIO_API_KEY')
|
||||
|
||||
# This must be generated manually from the website's interface.
|
||||
oauth2_token = os.getenv("MODIO_OAUTH2_TOKEN")
|
||||
|
||||
mod_file_path = os.getenv("MOD_FILE_PATH")
|
||||
mod_version = os.getenv("MOD_VERSION")
|
||||
|
||||
community_mod_id = 2144305
|
||||
zeroad_id = 5
|
||||
|
||||
headers = {
|
||||
'Authorization': f'Bearer {oauth2_token}',
|
||||
'Accept': 'application/json'
|
||||
}
|
||||
|
||||
r = requests.get(f'https://api.mod.io/v1/me/mods', params={
|
||||
'api_key': api_key
|
||||
}, headers = headers)
|
||||
|
||||
print(r.json())
|
||||
|
||||
files = {'filedata': open(mod_file_path, 'rb')}
|
||||
|
||||
mod_json = json.load(open(MOD_PATH / 'mod.json', 'r'))
|
||||
|
||||
signature = open('signature.minisign', 'r').read()
|
||||
|
||||
rq = requests.post(f'https://api.mod.io/v1/games/{zeroad_id}/mods/{community_mod_id}/files', files=files, headers=headers, data={
|
||||
'version': mod_version,
|
||||
'active': True,
|
||||
'metadata_blob' : json.dumps({
|
||||
'dependencies': mod_json['dependencies'],
|
||||
'minisigs': [signature]
|
||||
})
|
||||
})
|
||||
|
||||
print(rq.json())
|
139
scripts/scriptlib/__init__.py
Normal file
139
scripts/scriptlib/__init__.py
Normal file
@ -0,0 +1,139 @@
|
||||
from collections import Counter
|
||||
from decimal import Decimal
|
||||
from re import split
|
||||
from sys import stderr
|
||||
from xml.etree import ElementTree
|
||||
from os.path import exists
|
||||
|
||||
class SimulTemplateEntity:
|
||||
def __init__(self, vfs_root, logger):
|
||||
self.vfs_root = vfs_root
|
||||
self.logger = logger
|
||||
|
||||
def get_file(self, base_path, vfs_path, mod):
|
||||
default_path = self.vfs_root / mod / base_path
|
||||
file = (default_path/ "special" / "filter" / vfs_path).with_suffix('.xml')
|
||||
if not exists(file):
|
||||
file = (default_path / "mixins" / vfs_path).with_suffix('.xml')
|
||||
if not exists(file):
|
||||
file = (default_path / vfs_path).with_suffix('.xml')
|
||||
return file
|
||||
|
||||
def get_main_mod(self, base_path, vfs_path, mods):
|
||||
for mod in mods:
|
||||
fp = self.get_file(base_path, vfs_path, mod)
|
||||
if fp.exists():
|
||||
main_mod = mod
|
||||
break
|
||||
else:
|
||||
# default to first mod
|
||||
# it should then not exist
|
||||
# it will raise an exception when trying to read it
|
||||
main_mod = mods[0]
|
||||
return main_mod
|
||||
|
||||
def apply_layer(self, base_tag, tag):
|
||||
"""
|
||||
apply tag layer to base_tag
|
||||
"""
|
||||
if tag.get('datatype') == 'tokens':
|
||||
base_tokens = split(r'\s+', base_tag.text or '')
|
||||
tokens = split(r'\s+', tag.text or '')
|
||||
final_tokens = base_tokens.copy()
|
||||
for token in tokens:
|
||||
if token.startswith('-'):
|
||||
token_to_remove = token[1:]
|
||||
if token_to_remove in final_tokens:
|
||||
final_tokens.remove(token_to_remove)
|
||||
elif token not in final_tokens:
|
||||
final_tokens.append(token)
|
||||
base_tag.text = ' '.join(final_tokens)
|
||||
base_tag.set("datatype", "tokens")
|
||||
elif tag.get('op'):
|
||||
op = tag.get('op')
|
||||
op1 = Decimal(base_tag.text or '0')
|
||||
op2 = Decimal(tag.text or '0')
|
||||
# Try converting to integers if possible, to pass validation.
|
||||
if op == 'add':
|
||||
base_tag.text = str(int(op1 + op2) if int(op1 + op2) == op1 + op2 else op1 + op2)
|
||||
elif op == 'mul':
|
||||
base_tag.text = str(int(op1 * op2) if int(op1 * op2) == op1 * op2 else op1 * op2)
|
||||
elif op == 'mul_round':
|
||||
base_tag.text = str(round(op1 * op2))
|
||||
else:
|
||||
raise ValueError(f"Invalid operator '{op}'")
|
||||
else:
|
||||
base_tag.text = tag.text
|
||||
for prop in tag.attrib:
|
||||
if prop not in ('disable', 'replace', 'parent', 'merge'):
|
||||
base_tag.set(prop, tag.get(prop))
|
||||
for child in tag:
|
||||
base_child = base_tag.find(child.tag)
|
||||
if 'disable' in child.attrib:
|
||||
if base_child is not None:
|
||||
base_tag.remove(base_child)
|
||||
elif ('merge' not in child.attrib) or (base_child is not None):
|
||||
if 'replace' in child.attrib and base_child is not None:
|
||||
base_tag.remove(base_child)
|
||||
base_child = None
|
||||
if base_child is None:
|
||||
base_child = ElementTree.Element(child.tag)
|
||||
base_tag.append(base_child)
|
||||
self.apply_layer(base_child, child)
|
||||
if 'replace' in base_child.attrib:
|
||||
del base_child.attrib['replace']
|
||||
|
||||
def load_inherited(self, base_path, vfs_path, mods):
|
||||
entity = self._load_inherited(base_path, vfs_path, mods)
|
||||
entity[:] = sorted(entity[:], key=lambda x: x.tag)
|
||||
return entity
|
||||
|
||||
def _load_inherited(self, base_path, vfs_path, mods, base = None):
|
||||
"""
|
||||
vfs_path should be relative to base_path in a mod
|
||||
"""
|
||||
if '|' in vfs_path:
|
||||
paths = vfs_path.split("|", 1)
|
||||
base = self._load_inherited(base_path, paths[1], mods, base);
|
||||
base = self._load_inherited(base_path, paths[0], mods, base);
|
||||
return base
|
||||
|
||||
main_mod = self.get_main_mod(base_path, vfs_path, mods)
|
||||
fp = self.get_file(base_path, vfs_path, main_mod)
|
||||
layer = ElementTree.parse(fp).getroot()
|
||||
for el in layer.iter():
|
||||
children = [x.tag for x in el]
|
||||
duplicates = [x for x, c in Counter(children).items() if c > 1]
|
||||
if duplicates:
|
||||
for dup in duplicates:
|
||||
self.logger.warning(f"Duplicate child node '{dup}' in tag {el.tag} of {fp}")
|
||||
if layer.get('parent'):
|
||||
parent = self._load_inherited(base_path, layer.get('parent'), mods, base)
|
||||
self.apply_layer(parent, layer)
|
||||
return parent
|
||||
else:
|
||||
if not base:
|
||||
return layer
|
||||
else:
|
||||
self.apply_layer(base, layer)
|
||||
return base
|
||||
|
||||
|
||||
def find_files(vfs_root, mods, vfs_path, *ext_list):
|
||||
"""
|
||||
returns a list of 2-size tuple with:
|
||||
- Path relative to the mod base
|
||||
- full Path
|
||||
"""
|
||||
full_exts = ['.' + ext for ext in ext_list]
|
||||
|
||||
def find_recursive(dp, base):
|
||||
"""(relative Path, full Path) generator"""
|
||||
if dp.is_dir():
|
||||
if dp.name != '.svn' and dp.name != '.git' and not dp.name.endswith('~'):
|
||||
for fp in dp.iterdir():
|
||||
yield from find_recursive(fp, base)
|
||||
elif dp.suffix in full_exts:
|
||||
relative_file_path = dp.relative_to(base)
|
||||
yield (relative_file_path, dp.resolve())
|
||||
return [(rp, fp) for mod in mods for (rp, fp) in find_recursive(vfs_root / mod / vfs_path, vfs_root / mod)]
|
Loading…
Reference in New Issue
Block a user