diff --git a/.gitattributes b/.gitattributes index f91f646..bac4dbd 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,12 +1,12 @@ -# -# https://help.github.com/articles/dealing-with-line-endings/ -# -# Linux start script should use lf -/gradlew text eol=lf - -# These are Windows script files and should use crlf -*.bat text eol=crlf - -# Binary files should be left untouched -*.jar binary - +# +# https://help.github.com/articles/dealing-with-line-endings/ +# +# Linux start script should use lf +/gradlew text eol=lf + +# These are Windows script files and should use crlf +*.bat text eol=crlf + +# Binary files should be left untouched +*.jar binary + diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 9af0acf..a37aa3a 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,11 +1,11 @@ -version: 2 -updates: - - package-ecosystem: "gradle" - directory: "/" - schedule: - interval: "weekly" - - - package-ecosystem: "github-actions" - directory: "/" - schedule: - interval: "weekly" +version: 2 +updates: + - package-ecosystem: "gradle" + directory: "/" + schedule: + interval: "weekly" + + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml index a718674..303f164 100644 --- a/.github/workflows/gradle.yml +++ b/.github/workflows/gradle.yml @@ -1,67 +1,67 @@ -# This workflow uses actions that are not certified by GitHub. -# They are provided by a third-party and are governed by -# separate terms of service, privacy policy, and support -# documentation. -# This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow execution time -# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-gradle - -name: Java CI with Gradle - -on: - push: - branches: [ "master" ] - pull_request: - branches: [ "master" ] - -jobs: - build: - - runs-on: ubuntu-latest - permissions: - contents: read - - steps: - - uses: actions/checkout@v5 - - name: Set up JDK 25 - uses: actions/setup-java@v5 - with: - java-version: '25' - distribution: 'temurin' - - # Configure Gradle for optimal use in GitHub Actions, including caching of downloaded dependencies. - # See: https://github.com/gradle/actions/blob/main/setup-gradle/README.md - - name: Setup Gradle - uses: gradle/actions/setup-gradle@4d9f0ba0025fe599b4ebab900eb7f3a1d93ef4c2 # v5.0.0 - - - name: Build with Gradle Wrapper - run: ./gradlew build - - # NOTE: The Gradle Wrapper is the default and recommended way to run Gradle (https://docs.gradle.org/current/userguide/gradle_wrapper.html). - # If your project does not have the Gradle Wrapper configured, you can use the following configuration to run Gradle with a specified version. - # - # - name: Setup Gradle - # uses: gradle/actions/setup-gradle@4d9f0ba0025fe599b4ebab900eb7f3a1d93ef4c2 # v5.0.0 - # with: - # gradle-version: '8.9' - # - # - name: Build with Gradle 8.9 - # run: gradle build - - dependency-submission: - - runs-on: ubuntu-latest - permissions: - contents: write - - steps: - - uses: actions/checkout@v5 - - name: Set up JDK 25 - uses: actions/setup-java@v5 - with: - java-version: '25' - distribution: 'temurin' - - # Generates and submits a dependency graph, enabling Dependabot Alerts for all project dependencies. - # See: https://github.com/gradle/actions/blob/main/dependency-submission/README.md - - name: Generate and submit dependency graph - uses: gradle/actions/dependency-submission@4d9f0ba0025fe599b4ebab900eb7f3a1d93ef4c2 # v5.0.0 +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. +# This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow execution time +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-gradle + +name: Java CI with Gradle + +on: + push: + branches: [ "master" ] + pull_request: + branches: [ "master" ] + +jobs: + build: + + runs-on: ubuntu-latest + permissions: + contents: read + + steps: + - uses: actions/checkout@v5 + - name: Set up JDK 25 + uses: actions/setup-java@v5 + with: + java-version: '25' + distribution: 'temurin' + + # Configure Gradle for optimal use in GitHub Actions, including caching of downloaded dependencies. + # See: https://github.com/gradle/actions/blob/main/setup-gradle/README.md + - name: Setup Gradle + uses: gradle/actions/setup-gradle@4d9f0ba0025fe599b4ebab900eb7f3a1d93ef4c2 # v5.0.0 + + - name: Build with Gradle Wrapper + run: ./gradlew build + + # NOTE: The Gradle Wrapper is the default and recommended way to run Gradle (https://docs.gradle.org/current/userguide/gradle_wrapper.html). + # If your project does not have the Gradle Wrapper configured, you can use the following configuration to run Gradle with a specified version. + # + # - name: Setup Gradle + # uses: gradle/actions/setup-gradle@4d9f0ba0025fe599b4ebab900eb7f3a1d93ef4c2 # v5.0.0 + # with: + # gradle-version: '8.9' + # + # - name: Build with Gradle 8.9 + # run: gradle build + + dependency-submission: + + runs-on: ubuntu-latest + permissions: + contents: write + + steps: + - uses: actions/checkout@v5 + - name: Set up JDK 25 + uses: actions/setup-java@v5 + with: + java-version: '25' + distribution: 'temurin' + + # Generates and submits a dependency graph, enabling Dependabot Alerts for all project dependencies. + # See: https://github.com/gradle/actions/blob/main/dependency-submission/README.md + - name: Generate and submit dependency graph + uses: gradle/actions/dependency-submission@4d9f0ba0025fe599b4ebab900eb7f3a1d93ef4c2 # v5.0.0 diff --git a/.github/workflows/javadoc.yml b/.github/workflows/javadoc.yml index eb211a6..b6bb59d 100644 --- a/.github/workflows/javadoc.yml +++ b/.github/workflows/javadoc.yml @@ -1,31 +1,31 @@ -name: Generate JavaDoc and deploy to GitHub Pages - -on: - push: - branches: - [ "master" ] - -jobs: - build: - permissions: - contents: write - runs-on: ubuntu-latest - - steps: - - name: Checkout repo - uses: actions/checkout@v5 - - - name: Set up JDK - uses: actions/setup-java@v5 - with: - distribution: 'temurin' - java-version: '25' - - - name: Generate JavaDoc - run: ./gradlew javadoc - - - name: Deploy to GitHub Pages - uses: peaceiris/actions-gh-pages@v4 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} +name: Generate JavaDoc and deploy to GitHub Pages + +on: + push: + branches: + [ "master" ] + +jobs: + build: + permissions: + contents: write + runs-on: ubuntu-latest + + steps: + - name: Checkout repo + uses: actions/checkout@v5 + + - name: Set up JDK + uses: actions/setup-java@v5 + with: + distribution: 'temurin' + java-version: '25' + + - name: Generate JavaDoc + run: ./gradlew javadoc + + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v4 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./app/build/docs/javadoc \ No newline at end of file diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index b8d3478..8b5d896 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,53 +1,53 @@ -name: Build and Upload Release Assets - -on: - release: - types: [created] - -jobs: - build-and-upload: - runs-on: ubuntu-latest - permissions: - contents: write - - steps: - - name: Checkout code - uses: actions/checkout@v5 - - - name: Set up JDK 25 - uses: actions/setup-java@v5 - with: - java-version: '25' - distribution: 'temurin' - - - name: Setup Gradle - uses: gradle/actions/setup-gradle@v5 - - - name: Build JAR with Gradle - run: ./gradlew build - - - name: Build Debian package - run: ./package-deb.sh - - - name: Build ZIP archive - run: ./package-zip.sh - - - name: Build Windows package with bundled JRE - run: ./package-win.sh - - - name: Build macOS package with bundled JRE - run: ./package-macos.sh - - - name: Build Linux package with bundled JRE - run: ./package-linux.sh - - - name: Upload release assets - uses: softprops/action-gh-release@v2 - with: - files: | - ./app/build/libs/app.jar - ./numberguessinggame.deb - ./archive.zip - ./NumberGuessingGame-windows.zip - ./NumberGuessingGame-macos.zip - ./NumberGuessingGame-linux.tar.gz +name: Build and Upload Release Assets + +on: + release: + types: [created] + +jobs: + build-and-upload: + runs-on: ubuntu-latest + permissions: + contents: write + + steps: + - name: Checkout code + uses: actions/checkout@v5 + + - name: Set up JDK 25 + uses: actions/setup-java@v5 + with: + java-version: '25' + distribution: 'temurin' + + - name: Setup Gradle + uses: gradle/actions/setup-gradle@v5 + + - name: Build JAR with Gradle + run: ./gradlew build + + - name: Build Debian package + run: ./package-deb.sh + + - name: Build ZIP archive + run: ./package-zip.sh + + - name: Build Windows package with bundled JRE + run: ./package-win.sh + + - name: Build macOS package with bundled JRE + run: ./package-macos.sh + + - name: Build Linux package with bundled JRE + run: ./package-linux.sh + + - name: Upload release assets + uses: softprops/action-gh-release@v2 + with: + files: | + ./app/build/libs/app-all.jar + ./numberguessinggame.deb + ./archive.zip + ./NumberGuessingGame-windows.zip + ./NumberGuessingGame-macos.zip + ./NumberGuessingGame-linux.tar.xz diff --git a/.gitignore b/.gitignore index 20409e3..261574f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,38 +1,38 @@ -.gradle -**/build/ -!**/src/**/build/ - -# Ignore Gradle GUI config -gradle-app.setting - -# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) -!gradle-wrapper.jar - -# Avoid ignore Gradle wrappper properties -!gradle-wrapper.properties - -# Cache of project -.gradletasknamecache - -# Eclipse Gradle plugin generated files -# Eclipse Core -.project -# JDT-specific (Eclipse Java Development Tools) -.classpath - -# Ignore Gradle build output directory -build - -archive.zip -numberguessinggame.deb - -# JRE bundling artifacts -jre-windows/ -jre-macos/ -jre-linux/ -NumberGuessingGame-windows/ -NumberGuessingGame-macos/ -NumberGuessingGame-linux/ -NumberGuessingGame-windows.zip -NumberGuessingGame-macos.zip -NumberGuessingGame-linux.tar.gz +.gradle +**/build/ +!**/src/**/build/ + +# Ignore Gradle GUI config +gradle-app.setting + +# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) +!gradle-wrapper.jar + +# Avoid ignore Gradle wrappper properties +!gradle-wrapper.properties + +# Cache of project +.gradletasknamecache + +# Eclipse Gradle plugin generated files +# Eclipse Core +.project +# JDT-specific (Eclipse Java Development Tools) +.classpath + +# Ignore Gradle build output directory +build + +archive.zip +numberguessinggame.deb + +# JRE bundling artifacts +jre-windows/ +jre-macos/ +jre-linux/ +NumberGuessingGame-windows/ +NumberGuessingGame-macos/ +NumberGuessingGame-linux/ +NumberGuessingGame-windows.zip +NumberGuessingGame-macos.zip +NumberGuessingGame-linux.tar.gz diff --git a/.idea/.gitignore b/.idea/.gitignore index 26d3352..eaf91e2 100644 --- a/.idea/.gitignore +++ b/.idea/.gitignore @@ -1,3 +1,3 @@ -# Default ignored files -/shelf/ -/workspace.xml +# Default ignored files +/shelf/ +/workspace.xml diff --git a/.idea/compiler.xml b/.idea/compiler.xml index bcf4711..245a82c 100644 --- a/.idea/compiler.xml +++ b/.idea/compiler.xml @@ -1,6 +1,6 @@ - - - - - + + + + + \ No newline at end of file diff --git a/.idea/gradle.xml b/.idea/gradle.xml index c4a4b3e..1debce6 100644 --- a/.idea/gradle.xml +++ b/.idea/gradle.xml @@ -1,19 +1,18 @@ - - - - - - + + + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml index c0278ba..9063fa8 100644 --- a/.idea/misc.xml +++ b/.idea/misc.xml @@ -1,8 +1,8 @@ - - - - - - - + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml index 35eb1dd..c8397c9 100644 --- a/.idea/vcs.xml +++ b/.idea/vcs.xml @@ -1,6 +1,6 @@ - - - - - + + + + + \ No newline at end of file diff --git a/.vscode/extensions.json b/.vscode/extensions.json index add4f4e..158a851 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -1,5 +1,5 @@ -{ - "recommendations": [ - "vscjava.vscode-java-pack" - ] +{ + "recommendations": [ + "vscjava.vscode-java-pack" + ] } \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json index 081b96f..a21681f 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,4 +1,4 @@ -{ - "github.copilot.enable": false, - "java.configuration.updateBuildConfiguration": "automatic" +{ + "github.copilot.enable": false, + "java.configuration.updateBuildConfiguration": "automatic" } \ No newline at end of file diff --git a/LICENSE b/LICENSE index f288702..3877ae0 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,674 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. 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 -them 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 prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. 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. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey 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; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If 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 convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU 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 that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - 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. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -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. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - 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 -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - 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 3 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, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program 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, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU 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. But first, please read -. + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. 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 +them 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 prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. 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. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey 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; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If 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 convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + 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. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +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. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + 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 +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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 3 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, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program 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, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU 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. But first, please read +. diff --git a/README.md b/README.md index 17449f6..b054180 100644 --- a/README.md +++ b/README.md @@ -1,189 +1,181 @@ -# Number Guessing Game - -A simple number guessing game where you try to guess a randomly generated number. The game features both a user-friendly graphical user interface (GUI) and a classic console mode. The GUI provides visual feedback with color-coded hints and tracks your progress in real-time. - -**Features:** -- Swing-based GUI (default) -- Console mode (use `--console` flag) -- High score tracking with usernames -- Persistent score storage -- Cross-platform (Made in Java!) - -## Installation & Running - -### Installation via Debian Package (Linux) - -For Debian/Ubuntu and derivatives (recommended for terminal usage): - -1. Download the `.deb` package from the [latest release](https://github.com/Project516/NumberGuessingGame/releases) - - You can use curl to do it from the command line: - ```bash - curl -s -L -o numberguessingame.deb https://github.com/Project516/NumberGuessingGame/releases/download/0.x.y/numberguessinggame.deb - ``` - where `x` and `y` is the version you want. -2. Install it: - ```bash - sudo apt update # Update packages - sudo apt install ./numberguessinggame.deb # From directory with the deb package - sudo apt install -f # Install dependencies - echo 'export PATH=$PATH:/usr/games' >> ~/.bashrc # Add games directory to user PATH - source ~/.bashrc - ``` -3. Run from anywhere in your terminal: - ```bash - numberguessinggame - ``` - -To uninstall: -```bash -sudo apt remove numberguessinggame -sudo apt autoremove -y # Remove dependencies -``` - -### Standalone Packages with Bundled JRE (Recommended) - -Download the platform-specific package with bundled JRE from the [latest release](https://github.com/project516/numberguessinggame/releases): - -- **Windows**: `NumberGuessingGame-windows.zip` (no Java installation required) -- **macOS**: `NumberGuessingGame-macos.zip` (no Java installation required) -- **Linux**: `NumberGuessingGame-linux.tar.gz` (no Java installation required) - -Extract the downloaded archive and run: - -**On Windows:** -Run `run.bat` - -**On Linux/Mac:** -Run `run.sh` - -### Manual Installation (Requires Java) - -Download the `archive.zip` from the [latest release](https://github.com/project516/numberguessinggame/releases) - -#### Requirements - -- Java 8 or higher - -#### How to Run - -**On Windows:** -Run `run.bat` - -**On Linux/Mac:** -Run `run.sh` - -### How to Play - -The game now features both a graphical user interface (GUI) and a console mode. - -#### GUI Mode (Default) - -1. Start the game using one of the methods above -2. A window will appear with the game interface -3. Enter your guess in the text field and click "Submit Guess" or press Enter -4. The game will provide visual feedback: - - Blue text indicates your guess was too low - - Orange text indicates your guess was too high - - Green text indicates you guessed correctly! -5. The number of guesses is displayed and updated in real-time -6. When you guess correctly, you'll be prompted to enter your username -7. After entering your username, your score will be saved and the top high scores will be displayed -8. Click "New Game" to play again -9. Use the menu bar for additional options: - - File → New Game (Ctrl+N): Start a new game - - File → Exit: Close the application - - View → High Scores: View the top high scores - - Help → About: View game information - -#### Console Mode - -To run the classic console version, use the `--console` or `-c` flag: - -```bash -java -jar app.jar --console -# or -./run.sh --console # Linux/Mac -run.bat --console # Windows -``` - -In console mode: -1. Enter your guess when prompted -2. The game will tell you if your guess is too high or too low -3. Keep guessing until you find the correct number -4. The game will display how many guesses it took you -5. Enter your username when prompted to save your score -6. The top high scores will be displayed after saving your score - -### High Scores - -The game automatically tracks high scores (games won with the fewest guesses). High scores are stored persistently in your home directory at `~/.numberguessinggame/highscores.properties`. - -- The top 10 scores are kept -- Scores are sorted by the number of guesses (fewest is best) -- Each score includes the username and number of guesses -- High scores persist across game sessions -- View high scores from the GUI menu (View → High Scores) or after completing a game - -## Development - -### Requirements - -- Java 25 (Eclipse Temurin recommended for development) -- Gradle - -### Development Setup - -[SDKMAN!](https://sdkman.io) is the recommended way to install Java and Gradle: - -``` -sdk install java 25-tem -sdk install gradle -``` - -Alternatively, install Eclipse Temurin JDK directly from https://adoptium.net/ - -### Building - -From the project root: -``` -gradle build -``` - -### Running Tests - -``` -gradle test -``` - -### Creating Release Archives - -#### Zip Archive (Requires Java) - -**On Windows:** -Run `.\gradlew build` and `.\package.bat` from the project root. - -**On Linux/Mac:** -Run `./package.sh` from the project root. - -This will create `archive.zip` containing the application, run scripts, README, and LICENSE. The archive can be released to GitHub Releases. - -#### Debian Package - -**On Linux:** -Run `./package-deb.sh` from the project root. - -This will create `numberguessinggame.deb` which can be installed via `apt`/`dpkg` on Debian-based systems. The package can be released to GitHub Releases for easy distribution. - -#### Platform-Specific Packages with Bundled JRE - -**On Linux:** -Run the following scripts to create platform-specific packages with bundled JRE: - -```bash -./package-win.sh # Creates NumberGuessingGame-windows.zip -./package-macos.sh # Creates NumberGuessingGame-macos.zip -./package-linux.sh # Creates NumberGuessingGame-linux.tar.gz -``` - -These packages include a bundled JRE and do not require Java to be installed on the target system. They are automatically built and uploaded to GitHub Releases via GitHub Actions. +# Number Guessing Game + +A simple number guessing game where you try to guess a randomly generated number. The game features both a user-friendly graphical user interface (GUI) and a classic console mode. + +**Features:** +- Swing-based GUI (default) +- Console mode (use `--console` flag) +- High score tracking with usernames +- Persistent score storage +- Cross-platform + +## Installation & Running + +### Installation via Debian Package (APT) + +For Debian/Ubuntu and derivatives (recommended for terminal usage): + +1. Download the `.deb` package from the [latest release](https://github.com/Project516/NumberGuessingGame/releases) + + You can use curl to do it from the command line: + ```bash + curl -s -L -o numberguessingame.deb https://github.com/Project516/NumberGuessingGame/releases/download/0.x.y/numberguessinggame.deb + ``` + where `x` and `y` is the version you want. +2. Install it: + ```bash + sudo apt update # Update packages + sudo apt install ./numberguessinggame.deb # From directory with the deb package + sudo apt install -f # Install dependencies + echo 'export PATH=$PATH:/usr/games' >> ~/.bashrc # Add games directory to user PATH + source ~/.bashrc + ``` +3. Run from anywhere in your terminal: + ```bash + numberguessinggame + ``` + +To uninstall: +```bash +sudo apt remove numberguessinggame +sudo apt autoremove -y # Remove dependencies +``` + +### Standalone Packages with Bundled JRE (Recommended) + +Download the platform-specific package with bundled JRE from the [latest release](https://github.com/project516/numberguessinggame/releases): + +- **Windows**: `NumberGuessingGame-windows.zip` +- **macOS**: `NumberGuessingGame-macos.zip` +- **Linux**: `NumberGuessingGame-linux.tar.xz` + +Extract the downloaded archive and run: + +**On Windows:** +Run `run.bat` + +**On Linux/Mac:** +Run `run.sh` + +### Manual Installation (Requires Java) + +Download the `archive.zip` from the [latest release](https://github.com/project516/numberguessinggame/releases) + +#### Requirements + +- Java 8 or higher + +#### How to Run + +**On Windows:** +Run `run.bat` + +**On Linux/Mac:** +Run `run.sh` + +### How to Play + +The game features both a graphical user interface (GUI) and a console mode. + +#### GUI Mode (Default) + +1. Start the game using one of the methods above +2. A window will appear with the game interface +3. Enter your guess in the text field and click "Submit Guess" or press Enter +4. The game will provide visual feedback: + - Blue text indicates your guess was too low + - Orange text indicates your guess was too high + - Green text indicates you guessed correctly! +5. The number of guesses is displayed and updated in real-time +6. When you guess correctly, you'll be prompted to enter your username +7. After entering your username, your score will be saved and the top high scores will be displayed +8. Click "New Game" to play again +9. Use the menu bar for additional options: + - File → New Game (Ctrl+N): Start a new game + - File → Exit: Close the application + - View → High Scores: View the top high scores + - Help → About: View game information + +#### Console Mode + +To run the classic console version, use the `--console` or `-c` flag: + +```bash +java -jar app.jar --console +# or +./run.sh --console # Linux/Mac +run.bat --console # Windows +``` + +In console mode: +1. Enter your guess when prompted +2. The game will tell you if your guess is too high or too low +3. Keep guessing until you find the correct number +4. The game will display how many guesses it took you +5. Enter your username when prompted to save your score +6. The top high scores will be displayed after saving your score + +### High Scores + +The game automatically tracks high scores (games won with the least guesses). High scores are stored in your home directory at `~/.numberguessinggame/highscores.properties`. + +- The top 10 scores are kept +- Scores are sorted by the number of guesses (least is best) +- Each score includes the username and number of guesses +- High scores persist across game sessions +- View high scores from the GUI menu (View → High Scores) or after completing a game + +## Development + +### Requirements + +- Java 25 (Eclipse Temurin recommended for development) + +### Development Setup + +[SDKMAN!](https://sdkman.io) is the recommended way to install Java and Gradle: + +``` +sdk install java 25-tem +``` + +Alternatively, install Eclipse Temurin JDK directly from https://adoptium.net/ + +### Building + +From the project root: +``` +./gradlew build +``` + +### Creating Release Archives + +#### Zip Archive + +**On Windows:** +Run `.\gradlew build` and `.\package.bat` from the project root. + +**On Linux/Mac:** +Run `./package.sh` from the project root. + +This will create `archive.zip` containing the application, run scripts, README, and LICENSE. The archive can be released to GitHub Releases. + +#### Debian Package + +**On Linux:** +Run `./package-deb.sh` from the project root. + +This will create `numberguessinggame.deb` which can be installed via `apt`/`dpkg` on Debian-based systems. The package can be released to GitHub Releases for easy distribution. + +#### Platform-Specific Packages with Bundled JRE + +**On Linux:** +Run the following scripts to create platform-specific packages with bundled JRE: + +```bash +./package-win.sh # Creates NumberGuessingGame-windows.zip +./package-macos.sh # Creates NumberGuessingGame-macos.zip +./package-linux.sh # Creates NumberGuessingGame-linux.tar.xz +``` + +These packages include a bundled JRE and do not require Java to be installed on the target system. They are automatically built and uploaded to GitHub Releases via GitHub Actions. diff --git a/app/build.gradle b/app/build.gradle index bbe7ebc..9b3105f 100644 --- a/app/build.gradle +++ b/app/build.gradle @@ -1,63 +1,65 @@ -plugins { - // Apply the application plugin to add support for building a CLI application in Java. - id 'application' - - //Spotless - id 'com.diffplug.spotless' version '8.0.0' - - id 'com.gradleup.shadow' version '9.2.2' -} - -repositories { - // Use Maven Central for resolving dependencies. - mavenCentral() -} - -dependencies { - // This dependency is used by the application. - implementation libs.guava - - implementation files('../libs/jlibutils-0.0.1.jar') -} - -testing { - suites { - // Configure the built-in test suite - test { - // Use JUnit Jupiter test framework - useJUnitJupiter('5.14.1') - } - } -} - -// Apply a specific Java toolchain to ease working on different environments. -java { - toolchain { - // Use JDK 25 - languageVersion = JavaLanguageVersion.of(8) - } -} - -application { - // Define the main class for the application. - mainClass = 'io.github.project516.NumberGuessingGame.Main' -} - -compileJava.dependsOn spotlessApply - -spotless { - java { - googleJavaFormat('1.28.0').aosp() - target 'src/**/*.java' - removeUnusedImports() - } -} - -// Jar config -jar { - manifest { - attributes( - 'Main-Class': 'io.github.project516.NumberGuessingGame.Main' - ) - } -} +plugins { + // Apply the application plugin to add support for building a CLI application in Java. + id 'application' + + //Spotless + id 'com.diffplug.spotless' version '8.0.0' + + id 'com.gradleup.shadow' version '9.2.2' +} + +repositories { + // Use Maven Central for resolving dependencies. + mavenCentral() + gradlePluginPortal() + google() +} + +dependencies { + // This dependency is used by the application. + implementation libs.guava + + implementation files('../libs/jlibutils-0.0.1.jar') +} + +testing { + suites { + // Configure the built-in test suite + test { + // Use JUnit Jupiter test framework + useJUnitJupiter('5.14.1') + } + } +} + +// Apply a specific Java toolchain to ease working on different environments. +java { + toolchain { + // Use JDK 25 + languageVersion = JavaLanguageVersion.of(8) + } +} + +application { + // Define the main class for the application. + mainClass = 'io.github.project516.NumberGuessingGame.Main' +} + +compileJava.dependsOn spotlessApply + +spotless { + java { + googleJavaFormat('1.28.0').aosp() + target 'src/**/*.java' + removeUnusedImports() + } +} + +// Jar config +jar { + manifest { + attributes( + 'Main-Class': 'io.github.project516.NumberGuessingGame.Main' + ) + } +} diff --git a/app/src/main/java/io/github/project516/NumberGuessingGame/CheckGuess.java b/app/src/main/java/io/github/project516/NumberGuessingGame/CheckGuess.java index 5eb0af9..ece1d09 100644 --- a/app/src/main/java/io/github/project516/NumberGuessingGame/CheckGuess.java +++ b/app/src/main/java/io/github/project516/NumberGuessingGame/CheckGuess.java @@ -6,7 +6,7 @@ */ public class CheckGuess { /** - * Validates that a guess is within the acceptable range (1-100). + * Validates that a guess is within the acceptable range (1-101). * * @param guess the user's guess to validate * @throws IllegalArgumentException if the guess is less than 1 or greater than 101 diff --git a/app/src/main/java/io/github/project516/NumberGuessingGame/HighScore.java b/app/src/main/java/io/github/project516/NumberGuessingGame/HighScore.java index b5446f2..3163ed1 100644 --- a/app/src/main/java/io/github/project516/NumberGuessingGame/HighScore.java +++ b/app/src/main/java/io/github/project516/NumberGuessingGame/HighScore.java @@ -58,6 +58,11 @@ public int compareTo(HighScore other) { return Integer.compare(this.numberOfGuesses, other.numberOfGuesses); } + /** + * Returns a string representation of this high score in the format "username: X guess(es)". + * + * @return a formatted string containing the username and number of guesses + */ @Override public String toString() { return username + ": " + numberOfGuesses + " guess" + (numberOfGuesses == 1 ? "" : "es"); diff --git a/app/src/main/java/io/github/project516/NumberGuessingGame/RandomNumber.java b/app/src/main/java/io/github/project516/NumberGuessingGame/RandomNumber.java index 76d6949..5490449 100644 --- a/app/src/main/java/io/github/project516/NumberGuessingGame/RandomNumber.java +++ b/app/src/main/java/io/github/project516/NumberGuessingGame/RandomNumber.java @@ -12,10 +12,10 @@ public class RandomNumber { Random random = new Random(); /** - * Generates a random integer between 0 and the specified maximum value (inclusive). + * Generates a random integer between 0 (inclusive) and the specified maximum value (inclusive). * - * @param max the maximum value for the random number - * @return a random integer between 0 and max (inclusive) + * @param max the maximum value for the random number (inclusive) + * @return a random integer in the range [0, max] */ int number(int max) { diff --git a/app/src/main/java/io/github/project516/NumberGuessingGame/ReadVersionFile.java b/app/src/main/java/io/github/project516/NumberGuessingGame/ReadVersionFile.java index d76a8d2..2cac0c8 100644 --- a/app/src/main/java/io/github/project516/NumberGuessingGame/ReadVersionFile.java +++ b/app/src/main/java/io/github/project516/NumberGuessingGame/ReadVersionFile.java @@ -5,10 +5,7 @@ import java.io.InputStream; import java.io.InputStreamReader; -/** - * Reads version information for the Number Guessing Game. Currently returns a placeholder version - * string. - */ +/** Reads version information for the Number Guessing Game from the version.txt resource file. */ public class ReadVersionFile { /** * Retrieves the current version of the game by reading from the version.txt resource file. @@ -16,7 +13,7 @@ public class ReadVersionFile { * @return the version string */ public String readVersion() { - String content = "0.1.0"; // Placeholder version + String content = "1.0.0"; // Default fallback version try (InputStream inputStream = getClass().getClassLoader().getResourceAsStream("version.txt"); BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream))) { diff --git a/app/src/main/resources/version.txt b/app/src/main/resources/version.txt index d917d3e..8da0a6e 100644 --- a/app/src/main/resources/version.txt +++ b/app/src/main/resources/version.txt @@ -1 +1 @@ -0.1.2 +rolling \ No newline at end of file diff --git a/debian-package/DEBIAN/control b/debian-package/DEBIAN/control index 9c95902..f2ceca0 100644 --- a/debian-package/DEBIAN/control +++ b/debian-package/DEBIAN/control @@ -1,11 +1,11 @@ -Package: numberguessinggame -Version: 0.1.2 -Section: games -Priority: optional -Architecture: all -Depends: default-jre | java8-runtime -Maintainer: project516 -Description: A simple number guessing game - A simple number guessing game where you try to guess a randomly - generated number. The game will tell you if your guess is too high - or too low until you find the correct number. +Package: numberguessinggame +Version: 1.0.0 +Section: games +Priority: optional +Architecture: all +Depends: default-jre | java8-runtime +Maintainer: project516 +Description: A simple number guessing game + A simple number guessing game where you try to guess a randomly + generated number. The game will tell you if your guess is too high + or too low until you find the correct number. diff --git a/debian-package/DEBIAN/postinst b/debian-package/DEBIAN/postinst index 6e208a7..172334f 100755 --- a/debian-package/DEBIAN/postinst +++ b/debian-package/DEBIAN/postinst @@ -1,7 +1,7 @@ -#!/bin/sh -set -e - -# Make the game executable -chmod +x /usr/games/numberguessinggame - -exit 0 +#!/bin/sh +set -e + +# Make the game executable +chmod +x /usr/games/numberguessinggame + +exit 0 diff --git a/debian-package/usr/games/numberguessinggame b/debian-package/usr/games/numberguessinggame index 5a4bac3..26204bc 100755 --- a/debian-package/usr/games/numberguessinggame +++ b/debian-package/usr/games/numberguessinggame @@ -1,4 +1,4 @@ -#!/bin/sh -# Wrapper script to launch Number Guessing Game - -java -jar /usr/share/games/numberguessinggame/game.jar --console "$@" +#!/bin/sh +# Wrapper script to launch Number Guessing Game + +java -jar /usr/share/games/numberguessinggame/game.jar --console "$@" diff --git a/debian-package/usr/share/games/numberguessinggame/.gitignore b/debian-package/usr/share/games/numberguessinggame/.gitignore index 4ad43f9..9201ee0 100644 --- a/debian-package/usr/share/games/numberguessinggame/.gitignore +++ b/debian-package/usr/share/games/numberguessinggame/.gitignore @@ -1,4 +1,4 @@ -# Ignore all files in this directory (they are generated during build) -* -# But not this file -!.gitignore +# Ignore all files in this directory (they are generated during build) +* +# But not this file +!.gitignore diff --git a/gradle.properties b/gradle.properties index 175c8c8..6551ef4 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,4 +1,4 @@ -org.gradle.configuration-cache=true -org.gradle.parallel=true -org.gradle.caching=true -org.gradle.daemon=true +org.gradle.configuration-cache=true +org.gradle.parallel=true +org.gradle.caching=true +org.gradle.daemon=true diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index c513b58..e124c66 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -1,5 +1,5 @@ -[versions] -guava = "33.5.0-jre" - -[libraries] -guava = { module = "com.google.guava:guava", version.ref = "guava" } +[versions] +guava = "33.5.0-jre" + +[libraries] +guava = { module = "com.google.guava:guava", version.ref = "guava" } diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index bad7c24..a3396e3 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,7 +1,7 @@ -distributionBase=GRADLE_USER_HOME -distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-9.2.0-bin.zip -networkTimeout=10000 -validateDistributionUrl=true -zipStoreBase=GRADLE_USER_HOME -zipStorePath=wrapper/dists +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-9.2.0-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/package-deb.sh b/package-deb.sh index 0d36ceb..4acea79 100755 --- a/package-deb.sh +++ b/package-deb.sh @@ -1,50 +1,50 @@ -#!/bin/sh -# Script to create a Debian package (.deb) for Number Guessing Game -# This package can be installed on Debian-based Linux distributions (Ubuntu, Mint, etc.) -# Usage: ./package-deb.sh -# Output: numberguessinggame.deb - -# Exit immediately if any command fails -set -e - -echo "Building Number Guessing Game Debian package..." - -# Clean up any previous build artifacts -echo "Cleaning up previous builds..." -rm -rf debian-package/usr/share/games/numberguessinggame/* -rm -f numberguessinggame.deb - -# Build the application using Gradle -echo "Building application..." - -./gradlew build - -# Copy the compiled JAR file to the package directory -echo "Copying files to package directory..." -cp app/build/libs/app-all.jar debian-package/usr/share/games/numberguessinggame/game.jar - -# Copy documentation files -cp README.md debian-package/usr/share/games/numberguessinggame/README.md -cp LICENSE debian-package/usr/share/games/numberguessinggame/LICENSE - -# Set correct permissions for Debian package -echo "Setting file permissions..." -chmod 755 debian-package/DEBIAN -chmod 755 debian-package/DEBIAN/postinst -chmod 755 debian-package/usr/games/numberguessinggame - -# Build the .deb package using dpkg-deb -echo "Building .deb package..." -dpkg-deb --build debian-package numberguessinggame.deb - -# Display success message with installation instructions -echo "" -echo "✓ Debian package created: numberguessinggame.deb" -echo "" -echo "To install, run:" -echo " sudo apt install ./numberguessinggame.deb" -echo " sudo apt install -f # to install any missing dependencies" -echo "" -echo "After installation, run the game with:" -echo " numberguessinggame" -echo "" +#!/bin/sh +# Script to create a Debian package (.deb) for Number Guessing Game +# This package can be installed on Debian-based Linux distributions (Ubuntu, Mint, etc.) +# Usage: ./package-deb.sh +# Output: numberguessinggame.deb + +# Exit immediately if any command fails +set -e + +echo "Building Number Guessing Game Debian package..." + +# Clean up any previous build artifacts +echo "Cleaning up previous builds..." +rm -rf debian-package/usr/share/games/numberguessinggame/* +rm -f numberguessinggame.deb + +# Build the application using Gradle +echo "Building application..." + +./gradlew build + +# Copy the compiled JAR file to the package directory +echo "Copying files to package directory..." +cp app/build/libs/app-all.jar debian-package/usr/share/games/numberguessinggame/game.jar + +# Copy documentation files +cp README.md debian-package/usr/share/games/numberguessinggame/README.md +cp LICENSE debian-package/usr/share/games/numberguessinggame/LICENSE + +# Set correct permissions for Debian package +echo "Setting file permissions..." +chmod 755 debian-package/DEBIAN +chmod 755 debian-package/DEBIAN/postinst +chmod 755 debian-package/usr/games/numberguessinggame + +# Build the .deb package using dpkg-deb +echo "Building .deb package..." +dpkg-deb --build debian-package numberguessinggame.deb + +# Display success message with installation instructions +echo "" +echo "✓ Debian package created: numberguessinggame.deb" +echo "" +echo "To install, run:" +echo " sudo apt install ./numberguessinggame.deb" +echo " sudo apt install -f # to install any missing dependencies" +echo "" +echo "After installation, run the game with:" +echo " numberguessinggame" +echo "" diff --git a/package-linux.sh b/package-linux.sh index 26d452a..6e1843c 100755 --- a/package-linux.sh +++ b/package-linux.sh @@ -1,71 +1,72 @@ -#!/bin/sh -# Script to create a Linux package with bundled JRE for Number Guessing Game -# This creates a self-contained package that doesn't require Java to be installed -# Output: NumberGuessingGame-linux.tar.gz - -# Exit immediately if any command fails -set -e - -echo "Building Number Guessing Game for Linux with bundled JRE..." - -# Configuration -PACKAGE_NAME="NumberGuessingGame-linux" -JRE_DIR="jre-linux" -ADOPTIUM_BASE_URL="https://api.adoptium.net/v3/binary/latest/8/ga" - -# Clean up any previous builds -rm -rf ${PACKAGE_NAME} -rm -rf ${JRE_DIR} -rm -f ${PACKAGE_NAME}.tar.gz - -# Build the application using Gradle -echo "Building application..." -./gradlew build - -# Download JRE for Linux from Eclipse Adoptium -echo "Downloading JRE for Linux..." -mkdir -p ${JRE_DIR} -curl -L "${ADOPTIUM_BASE_URL}/linux/x64/jre/hotspot/normal/eclipse?project=jdk" -o ${JRE_DIR}/jre-linux.tar.gz - -# Extract the downloaded JRE -echo "Extracting JRE..." -cd ${JRE_DIR} -tar -xzf jre-linux.tar.gz -JRE_EXTRACTED=$(ls -d jdk* 2>/dev/null || ls -d jre* 2>/dev/null) -cd .. - -# Create package directory structure -echo "Creating package structure..." -mkdir -p ${PACKAGE_NAME} -cp app/build/libs/app-all.jar ${PACKAGE_NAME}/game.jar -cp README.md ${PACKAGE_NAME}/README.txt -cp LICENSE ${PACKAGE_NAME}/LICENSE - -# Copy the JRE into the package -echo "Copying JRE into package..." -cp -r ${JRE_DIR}/${JRE_EXTRACTED} ${PACKAGE_NAME}/jre - -# Create a shell script that uses the bundled JRE -cat > ${PACKAGE_NAME}/run.sh << 'EOF' -#!/bin/sh - -# Get the directory where the script is located -SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" - -"${SCRIPT_DIR}/jre/bin/java" -jar "${SCRIPT_DIR}/game.jar" -EOF - -# Make the run script executable -chmod +x ${PACKAGE_NAME}/run.sh - -# Create the final tar.gz archive -echo "Creating tar.gz archive..." -tar -czf ${PACKAGE_NAME}.tar.gz ${PACKAGE_NAME}/ - -# Clean up temporary directories -rm -rf ${PACKAGE_NAME} -rm -rf ${JRE_DIR} - -echo "" -echo "✓ Linux package with bundled JRE created: ${PACKAGE_NAME}.tar.gz" -echo "" +#!/bin/sh +# Script to create a Linux package with bundled JRE for Number Guessing Game +# This creates a self-contained package that doesn't require Java to be installed +# Output: NumberGuessingGame-linux.tar.xz + +# Exit immediately if any command fails +set -e + +echo "Building Number Guessing Game for Linux with bundled JRE..." + +# Configuration +PACKAGE_NAME="NumberGuessingGame-linux" +JRE_DIR="jre-linux" +ADOPTIUM_BASE_URL="https://api.adoptium.net/v3/binary/latest/8/ga" + +# Clean up any previous builds +rm -rf ${PACKAGE_NAME} +rm -rf ${JRE_DIR} +rm -f ${PACKAGE_NAME}.tar.xz +rm -f ${PACKAGE_NAME}.tar.gz + +# Build the application using Gradle +echo "Building application..." +./gradlew build + +# Download JRE for Linux from Eclipse Adoptium +echo "Downloading JRE for Linux..." +mkdir -p ${JRE_DIR} +curl -L "${ADOPTIUM_BASE_URL}/linux/x64/jre/hotspot/normal/eclipse?project=jdk" -o ${JRE_DIR}/jre-linux.tar.gz + +# Extract the downloaded JRE +echo "Extracting JRE..." +cd ${JRE_DIR} +tar -xzf jre-linux.tar.gz +JRE_EXTRACTED=$(ls -d jdk* 2>/dev/null || ls -d jre* 2>/dev/null) +cd .. + +# Create package directory structure +echo "Creating package structure..." +mkdir -p ${PACKAGE_NAME} +cp app/build/libs/app-all.jar ${PACKAGE_NAME}/game.jar +cp README.md ${PACKAGE_NAME}/README.txt +cp LICENSE ${PACKAGE_NAME}/LICENSE + +# Copy the JRE into the package +echo "Copying JRE into package..." +cp -r ${JRE_DIR}/${JRE_EXTRACTED} ${PACKAGE_NAME}/jre + +# Create a shell script that uses the bundled JRE +cat > ${PACKAGE_NAME}/run.sh << 'EOF' +#!/bin/sh + +# Get the directory where the script is located +SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" + +"${SCRIPT_DIR}/jre/bin/java" -jar "${SCRIPT_DIR}/game.jar" +EOF + +# Make the run script executable +chmod +x ${PACKAGE_NAME}/run.sh + +# Create the final tar.xz archive with maximum compression +echo "Creating tar.xz archive..." +tar -cJf ${PACKAGE_NAME}.tar.xz ${PACKAGE_NAME}/ + +# Clean up temporary directories +rm -rf ${PACKAGE_NAME} +rm -rf ${JRE_DIR} + +echo "" +echo "✓ Linux package with bundled JRE created: ${PACKAGE_NAME}.tar.xz" +echo "" diff --git a/package-macos.sh b/package-macos.sh index b87bc2e..1a2eca8 100755 --- a/package-macos.sh +++ b/package-macos.sh @@ -1,71 +1,71 @@ -#!/bin/sh -# Script to create a macOS package with bundled JRE for Number Guessing Game -# This creates a self-contained package that doesn't require Java to be installed -# Output: NumberGuessingGame-macos.zip - -# Exit immediately if any command fails -set -e - -echo "Building Number Guessing Game for macOS with bundled JRE..." - -# Configuration -PACKAGE_NAME="NumberGuessingGame-macos" -JRE_DIR="jre-macos" -ADOPTIUM_BASE_URL="https://api.adoptium.net/v3/binary/latest/8/ga" - -# Clean up any previous builds -rm -rf ${PACKAGE_NAME} -rm -rf ${JRE_DIR} -rm -f ${PACKAGE_NAME}.zip - -# Build the application using Gradle -echo "Building application..." -./gradlew build - -# Download JRE for macOS from Eclipse Adoptium -echo "Downloading JRE for macOS..." -mkdir -p ${JRE_DIR} -curl -L "${ADOPTIUM_BASE_URL}/mac/x64/jre/hotspot/normal/eclipse?project=jdk" -o ${JRE_DIR}/jre-macos.tar.gz - -# Extract the downloaded JRE -echo "Extracting JRE..." -cd ${JRE_DIR} -tar -xzf jre-macos.tar.gz -JRE_EXTRACTED=$(ls -d jdk* 2>/dev/null || ls -d jre* 2>/dev/null) -cd .. - -# Create package directory structure -echo "Creating package structure..." -mkdir -p ${PACKAGE_NAME} -cp app/build/libs/app-all.jar ${PACKAGE_NAME}/game.jar -cp README.md ${PACKAGE_NAME}/README.txt -cp LICENSE ${PACKAGE_NAME}/LICENSE - -# Copy the JRE into the package -echo "Copying JRE into package..." -cp -r ${JRE_DIR}/${JRE_EXTRACTED} ${PACKAGE_NAME}/jre - -# Create a shell script that uses the bundled JRE (macOS JRE structure: Contents/Home) -cat > ${PACKAGE_NAME}/run.sh << 'EOF' -#!/bin/sh - -# Get the directory where the script is located -SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" - -"${SCRIPT_DIR}/jre/Contents/Home/bin/java" -jar "${SCRIPT_DIR}/game.jar" -EOF - -# Make the run script executable -chmod +x ${PACKAGE_NAME}/run.sh - -# Create the final zip archive -echo "Creating zip archive..." -zip -r ${PACKAGE_NAME}.zip ${PACKAGE_NAME}/ - -# Clean up temporary directories -rm -rf ${PACKAGE_NAME} -rm -rf ${JRE_DIR} - -echo "" -echo "✓ macOS package with bundled JRE created: ${PACKAGE_NAME}.zip" -echo "" +#!/bin/sh +# Script to create a macOS package with bundled JRE for Number Guessing Game +# This creates a self-contained package that doesn't require Java to be installed +# Output: NumberGuessingGame-macos.zip + +# Exit immediately if any command fails +set -e + +echo "Building Number Guessing Game for macOS with bundled JRE..." + +# Configuration +PACKAGE_NAME="NumberGuessingGame-macos" +JRE_DIR="jre-macos" +ADOPTIUM_BASE_URL="https://api.adoptium.net/v3/binary/latest/8/ga" + +# Clean up any previous builds +rm -rf ${PACKAGE_NAME} +rm -rf ${JRE_DIR} +rm -f ${PACKAGE_NAME}.zip + +# Build the application using Gradle +echo "Building application..." +./gradlew build + +# Download JRE for macOS from Eclipse Adoptium +echo "Downloading JRE for macOS..." +mkdir -p ${JRE_DIR} +curl -L "${ADOPTIUM_BASE_URL}/mac/x64/jre/hotspot/normal/eclipse?project=jdk" -o ${JRE_DIR}/jre-macos.tar.gz + +# Extract the downloaded JRE +echo "Extracting JRE..." +cd ${JRE_DIR} +tar -xzf jre-macos.tar.gz +JRE_EXTRACTED=$(ls -d jdk* 2>/dev/null || ls -d jre* 2>/dev/null) +cd .. + +# Create package directory structure +echo "Creating package structure..." +mkdir -p ${PACKAGE_NAME} +cp app/build/libs/app-all.jar ${PACKAGE_NAME}/game.jar +cp README.md ${PACKAGE_NAME}/README.txt +cp LICENSE ${PACKAGE_NAME}/LICENSE + +# Copy the JRE into the package +echo "Copying JRE into package..." +cp -r ${JRE_DIR}/${JRE_EXTRACTED} ${PACKAGE_NAME}/jre + +# Create a shell script that uses the bundled JRE (macOS JRE structure: Contents/Home) +cat > ${PACKAGE_NAME}/run.sh << 'EOF' +#!/bin/sh + +# Get the directory where the script is located +SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" + +"${SCRIPT_DIR}/jre/Contents/Home/bin/java" -jar "${SCRIPT_DIR}/game.jar" +EOF + +# Make the run script executable +chmod +x ${PACKAGE_NAME}/run.sh + +# Create the final zip archive with maximum compression +echo "Creating zip archive..." +zip -9 -r ${PACKAGE_NAME}.zip ${PACKAGE_NAME}/ + +# Clean up temporary directories +rm -rf ${PACKAGE_NAME} +rm -rf ${JRE_DIR} + +echo "" +echo "✓ macOS package with bundled JRE created: ${PACKAGE_NAME}.zip" +echo "" diff --git a/package-win.sh b/package-win.sh index 5f9d671..c2f55da 100755 --- a/package-win.sh +++ b/package-win.sh @@ -54,9 +54,9 @@ jre\bin\java.exe -jar game.jar @pause EOF -# Create the final zip archive +# Create the final zip archive with maximum compression echo "Creating zip archive..." -zip -r ${PACKAGE_NAME}.zip ${PACKAGE_NAME}/ +zip -9 -r ${PACKAGE_NAME}.zip ${PACKAGE_NAME}/ # Clean up temporary directories rm -rf ${PACKAGE_NAME} diff --git a/package-zip.bat b/package-zip.bat index bdc0e6a..5baaeaa 100644 --- a/package-zip.bat +++ b/package-zip.bat @@ -17,8 +17,8 @@ copy scripts\run.sh NumberGuessingGame\run.sh copy README.md NumberGuessingGame\README.txt copy LICENSE NumberGuessingGame\LICENSE -REM Create the ZIP archive using PowerShell -powershell -command "Compress-Archive -Path NumberGuessingGame -DestinationPath archive.zip -Force" +REM Create the ZIP archive using PowerShell with maximum compression +powershell -command "Compress-Archive -Path NumberGuessingGame -DestinationPath archive.zip -CompressionLevel Optimal -Force" REM Clean up temporary directory rmdir /s /q NumberGuessingGame diff --git a/package-zip.sh b/package-zip.sh index 712ed00..58b62d4 100755 --- a/package-zip.sh +++ b/package-zip.sh @@ -1,29 +1,29 @@ -#!/bin/sh -# Creates a distributable ZIP archive of the game -# This archive requires Java to be installed on the user's system - -# Clean up any previous builds -rm -rf NumberGuessingGame -rm -rf temp -rm -f archive.zip - -# Build the application -cd app -gradle build -cd .. - -# Create distribution directory structure -mkdir NumberGuessingGame - -# Copy the game JAR and necessary files -cp -r app/build/libs/app-all.jar NumberGuessingGame/game.jar -cp -r scripts/run.bat NumberGuessingGame/run.bat -cp -r scripts/run.sh NumberGuessingGame/run.sh -cp -r README.md NumberGuessingGame/README.txt -cp -r LICENSE NumberGuessingGame/LICENSE - -# Create the ZIP archive -zip -r archive.zip NumberGuessingGame/ - -# Clean up temporary directory -rm -rf NumberGuessingGame +#!/bin/sh +# Creates a distributable ZIP archive of the game +# This archive requires Java to be installed on the user's system + +# Clean up any previous builds +rm -rf NumberGuessingGame +rm -rf temp +rm -f archive.zip + +# Build the application +cd app +gradle build +cd .. + +# Create distribution directory structure +mkdir NumberGuessingGame + +# Copy the game JAR and necessary files +cp -r app/build/libs/app-all.jar NumberGuessingGame/game.jar +cp -r scripts/run.bat NumberGuessingGame/run.bat +cp -r scripts/run.sh NumberGuessingGame/run.sh +cp -r README.md NumberGuessingGame/README.txt +cp -r LICENSE NumberGuessingGame/LICENSE + +# Create the ZIP archive with maximum compression +zip -9 -r archive.zip NumberGuessingGame/ + +# Clean up temporary directory +rm -rf NumberGuessingGame diff --git a/renovate.json b/renovate.json index 5db72dd..8ace211 100644 --- a/renovate.json +++ b/renovate.json @@ -1,6 +1,6 @@ -{ - "$schema": "https://docs.renovatebot.com/renovate-schema.json", - "extends": [ - "config:recommended" - ] -} +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": [ + "config:recommended" + ] +} diff --git a/scripts/run.sh b/scripts/run.sh index eac680f..d6126e3 100644 --- a/scripts/run.sh +++ b/scripts/run.sh @@ -1,6 +1,6 @@ -#!/bin/sh -# Run script for Number Guessing Game (Linux/Mac) -# This script starts the GUI version of the game -# For console mode, add --console flag: ./run.sh --console - -java -jar game.jar +#!/bin/sh +# Run script for Number Guessing Game (Linux/Mac) +# This script starts the GUI version of the game +# For console mode, add --console flag: ./run.sh --console + +java -jar game.jar diff --git a/settings.gradle b/settings.gradle index 25c2de5..8e894fd 100644 --- a/settings.gradle +++ b/settings.gradle @@ -1,7 +1,7 @@ -plugins { - // Apply the foojay-resolver plugin to allow automatic download of JDKs - id 'org.gradle.toolchains.foojay-resolver-convention' version '1.0.0' -} - -rootProject.name = 'NumberGuessingGame' -include('app') +plugins { + // Apply the foojay-resolver plugin to allow automatic download of JDKs + id 'org.gradle.toolchains.foojay-resolver-convention' version '1.0.0' +} + +rootProject.name = 'NumberGuessingGame' +include('app') diff --git a/test-gui.sh b/test-gui.sh index 50d26ae..452e766 100644 --- a/test-gui.sh +++ b/test-gui.sh @@ -1,9 +1,9 @@ -#!/bin/sh -# Quick test script for GUI mode -# This script builds the project and runs the graphical version of the game - -# Build the project using Gradle -./gradlew build - -# Run the game in GUI mode (default - opens a window) -java -jar app/build/libs/app-all.jar +#!/bin/sh +# Quick test script for GUI mode +# This script builds the project and runs the graphical version of the game + +# Build the project using Gradle +./gradlew build + +# Run the game in GUI mode (default - opens a window) +java -jar app/build/libs/app-all.jar diff --git a/test.sh b/test.sh index 38f354c..ac2aedf 100755 --- a/test.sh +++ b/test.sh @@ -1,9 +1,9 @@ -#!/bin/sh -# Quick test script for console mode -# This script builds the project and runs the console version of the game - -# Build the project using Gradle -./gradlew build - -# Run the game in console mode (text-based interface) -java -jar app/build/libs/app-all.jar --console +#!/bin/sh +# Quick test script for console mode +# This script builds the project and runs the console version of the game + +# Build the project using Gradle +./gradlew build + +# Run the game in console mode (text-based interface) +java -jar app/build/libs/app-all.jar --console