├── .github └── workflows │ ├── ci.yml │ └── release.yml ├── .gitignore ├── .idea ├── .gitignore ├── markdown.xml ├── misc.xml ├── modules.xml ├── runConfigurations │ └── Run.xml └── vcs.xml ├── Cargo.lock ├── Cargo.toml ├── LICENSE ├── README.md ├── logo.pdn ├── mcping.iml └── src ├── arguments.rs ├── buffer.rs ├── connection.rs ├── error.rs ├── lib.rs ├── main.rs ├── parse.rs ├── response ├── chat.rs ├── description.rs ├── mod.rs ├── player.rs ├── player_list.rs └── version.rs └── result.rs /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: Continuous Integration 2 | 3 | on: 4 | push: 5 | branches: [ "master" ] 6 | pull_request: 7 | branches: [ "master" ] 8 | 9 | env: 10 | CARGO_TERM_COLOR: always 11 | 12 | jobs: 13 | build: 14 | 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - uses: actions/checkout@v3 19 | - name: Build 20 | run: cargo build --verbose 21 | - name: Run tests 22 | run: cargo test --verbose 23 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release Binaries 2 | 3 | on: 4 | push: 5 | tags: 6 | - v[0-9]+.* 7 | 8 | jobs: 9 | create-release: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@v3 13 | - uses: taiki-e/create-gh-release-action@v1 14 | env: 15 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 16 | 17 | upload-assets: 18 | strategy: 19 | matrix: 20 | os: 21 | - ubuntu-latest 22 | - macos-latest 23 | - windows-latest 24 | runs-on: ${{ matrix.os }} 25 | steps: 26 | - uses: actions/checkout@v3 27 | - uses: taiki-e/upload-rust-binary-action@v1 28 | with: 29 | bin: mcping 30 | archive: $bin-$tag-$target 31 | tar: unix 32 | zip: windows 33 | env: 34 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 35 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | -------------------------------------------------------------------------------- /.idea/.gitignore: -------------------------------------------------------------------------------- 1 | # Default ignored files 2 | /shelf/ 3 | /workspace.xml 4 | -------------------------------------------------------------------------------- /.idea/markdown.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | -------------------------------------------------------------------------------- /.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /.idea/modules.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /.idea/runConfigurations/Run.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 19 | -------------------------------------------------------------------------------- /.idea/vcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /Cargo.lock: -------------------------------------------------------------------------------- 1 | # This file is automatically @generated by Cargo. 2 | # It is not intended for manual editing. 3 | version = 3 4 | 5 | [[package]] 6 | name = "anstream" 7 | version = "0.6.5" 8 | source = "registry+https://github.com/rust-lang/crates.io-index" 9 | checksum = "d664a92ecae85fd0a7392615844904654d1d5f5514837f471ddef4a057aba1b6" 10 | dependencies = [ 11 | "anstyle", 12 | "anstyle-parse", 13 | "anstyle-query", 14 | "anstyle-wincon", 15 | "colorchoice", 16 | "utf8parse", 17 | ] 18 | 19 | [[package]] 20 | name = "anstyle" 21 | version = "1.0.4" 22 | source = "registry+https://github.com/rust-lang/crates.io-index" 23 | checksum = "7079075b41f533b8c61d2a4d073c4676e1f8b249ff94a393b0595db304e0dd87" 24 | 25 | [[package]] 26 | name = "anstyle-parse" 27 | version = "0.2.3" 28 | source = "registry+https://github.com/rust-lang/crates.io-index" 29 | checksum = "c75ac65da39e5fe5ab759307499ddad880d724eed2f6ce5b5e8a26f4f387928c" 30 | dependencies = [ 31 | "utf8parse", 32 | ] 33 | 34 | [[package]] 35 | name = "anstyle-query" 36 | version = "1.0.2" 37 | source = "registry+https://github.com/rust-lang/crates.io-index" 38 | checksum = "e28923312444cdd728e4738b3f9c9cac739500909bb3d3c94b43551b16517648" 39 | dependencies = [ 40 | "windows-sys", 41 | ] 42 | 43 | [[package]] 44 | name = "anstyle-wincon" 45 | version = "3.0.2" 46 | source = "registry+https://github.com/rust-lang/crates.io-index" 47 | checksum = "1cd54b81ec8d6180e24654d0b371ad22fc3dd083b6ff8ba325b72e00c87660a7" 48 | dependencies = [ 49 | "anstyle", 50 | "windows-sys", 51 | ] 52 | 53 | [[package]] 54 | name = "clap" 55 | version = "4.4.11" 56 | source = "registry+https://github.com/rust-lang/crates.io-index" 57 | checksum = "bfaff671f6b22ca62406885ece523383b9b64022e341e53e009a62ebc47a45f2" 58 | dependencies = [ 59 | "clap_builder", 60 | "clap_derive", 61 | ] 62 | 63 | [[package]] 64 | name = "clap_builder" 65 | version = "4.4.11" 66 | source = "registry+https://github.com/rust-lang/crates.io-index" 67 | checksum = "a216b506622bb1d316cd51328dce24e07bdff4a6128a47c7e7fad11878d5adbb" 68 | dependencies = [ 69 | "anstream", 70 | "anstyle", 71 | "clap_lex", 72 | "strsim", 73 | ] 74 | 75 | [[package]] 76 | name = "clap_derive" 77 | version = "4.4.7" 78 | source = "registry+https://github.com/rust-lang/crates.io-index" 79 | checksum = "cf9804afaaf59a91e75b022a30fb7229a7901f60c755489cc61c9b423b836442" 80 | dependencies = [ 81 | "heck", 82 | "proc-macro2", 83 | "quote", 84 | "syn 2.0.39", 85 | ] 86 | 87 | [[package]] 88 | name = "clap_lex" 89 | version = "0.6.0" 90 | source = "registry+https://github.com/rust-lang/crates.io-index" 91 | checksum = "702fc72eb24e5a1e48ce58027a675bc24edd52096d5397d4aea7c6dd9eca0bd1" 92 | 93 | [[package]] 94 | name = "colorchoice" 95 | version = "1.0.0" 96 | source = "registry+https://github.com/rust-lang/crates.io-index" 97 | checksum = "acbf1af155f9b9ef647e42cdc158db4b64a1b61f743629225fde6f3e0be2a7c7" 98 | 99 | [[package]] 100 | name = "heck" 101 | version = "0.4.0" 102 | source = "registry+https://github.com/rust-lang/crates.io-index" 103 | checksum = "2540771e65fc8cb83cd6e8a237f70c319bd5c29f78ed1084ba5d50eeac86f7f9" 104 | 105 | [[package]] 106 | name = "itoa" 107 | version = "1.0.2" 108 | source = "registry+https://github.com/rust-lang/crates.io-index" 109 | checksum = "112c678d4050afce233f4f2852bb2eb519230b3cf12f33585275537d7e41578d" 110 | 111 | [[package]] 112 | name = "mc-varint" 113 | version = "0.1.1" 114 | source = "registry+https://github.com/rust-lang/crates.io-index" 115 | checksum = "6407d50d4e371d5f450a4a5f1abd4531e48e9a1627409c051b5d4c7c84f6bb09" 116 | 117 | [[package]] 118 | name = "mcping" 119 | version = "0.2.0" 120 | dependencies = [ 121 | "clap", 122 | "mc-varint", 123 | "serde", 124 | "serde_json", 125 | ] 126 | 127 | [[package]] 128 | name = "proc-macro2" 129 | version = "1.0.70" 130 | source = "registry+https://github.com/rust-lang/crates.io-index" 131 | checksum = "39278fbbf5fb4f646ce651690877f89d1c5811a3d4acb27700c1cb3cdb78fd3b" 132 | dependencies = [ 133 | "unicode-ident", 134 | ] 135 | 136 | [[package]] 137 | name = "quote" 138 | version = "1.0.33" 139 | source = "registry+https://github.com/rust-lang/crates.io-index" 140 | checksum = "5267fca4496028628a95160fc423a33e8b2e6af8a5302579e322e4b520293cae" 141 | dependencies = [ 142 | "proc-macro2", 143 | ] 144 | 145 | [[package]] 146 | name = "ryu" 147 | version = "1.0.10" 148 | source = "registry+https://github.com/rust-lang/crates.io-index" 149 | checksum = "f3f6f92acf49d1b98f7a81226834412ada05458b7364277387724a237f062695" 150 | 151 | [[package]] 152 | name = "serde" 153 | version = "1.0.137" 154 | source = "registry+https://github.com/rust-lang/crates.io-index" 155 | checksum = "61ea8d54c77f8315140a05f4c7237403bf38b72704d031543aa1d16abbf517d1" 156 | dependencies = [ 157 | "serde_derive", 158 | ] 159 | 160 | [[package]] 161 | name = "serde_derive" 162 | version = "1.0.137" 163 | source = "registry+https://github.com/rust-lang/crates.io-index" 164 | checksum = "1f26faba0c3959972377d3b2d306ee9f71faee9714294e41bb777f83f88578be" 165 | dependencies = [ 166 | "proc-macro2", 167 | "quote", 168 | "syn 1.0.96", 169 | ] 170 | 171 | [[package]] 172 | name = "serde_json" 173 | version = "1.0.81" 174 | source = "registry+https://github.com/rust-lang/crates.io-index" 175 | checksum = "9b7ce2b32a1aed03c558dc61a5cd328f15aff2dbc17daad8fb8af04d2100e15c" 176 | dependencies = [ 177 | "itoa", 178 | "ryu", 179 | "serde", 180 | ] 181 | 182 | [[package]] 183 | name = "strsim" 184 | version = "0.10.0" 185 | source = "registry+https://github.com/rust-lang/crates.io-index" 186 | checksum = "73473c0e59e6d5812c5dfe2a064a6444949f089e20eec9a2e5506596494e4623" 187 | 188 | [[package]] 189 | name = "syn" 190 | version = "1.0.96" 191 | source = "registry+https://github.com/rust-lang/crates.io-index" 192 | checksum = "0748dd251e24453cb8717f0354206b91557e4ec8703673a4b30208f2abaf1ebf" 193 | dependencies = [ 194 | "proc-macro2", 195 | "quote", 196 | "unicode-ident", 197 | ] 198 | 199 | [[package]] 200 | name = "syn" 201 | version = "2.0.39" 202 | source = "registry+https://github.com/rust-lang/crates.io-index" 203 | checksum = "23e78b90f2fcf45d3e842032ce32e3f2d1545ba6636271dcbf24fa306d87be7a" 204 | dependencies = [ 205 | "proc-macro2", 206 | "quote", 207 | "unicode-ident", 208 | ] 209 | 210 | [[package]] 211 | name = "unicode-ident" 212 | version = "1.0.0" 213 | source = "registry+https://github.com/rust-lang/crates.io-index" 214 | checksum = "d22af068fba1eb5edcb4aea19d382b2a3deb4c8f9d475c589b6ada9e0fd493ee" 215 | 216 | [[package]] 217 | name = "utf8parse" 218 | version = "0.2.1" 219 | source = "registry+https://github.com/rust-lang/crates.io-index" 220 | checksum = "711b9620af191e0cdc7468a8d14e709c3dcdb115b36f838e601583af800a370a" 221 | 222 | [[package]] 223 | name = "windows-sys" 224 | version = "0.52.0" 225 | source = "registry+https://github.com/rust-lang/crates.io-index" 226 | checksum = "282be5f36a8ce781fad8c8ae18fa3f9beff57ec1b52cb3de0789201425d9a33d" 227 | dependencies = [ 228 | "windows-targets", 229 | ] 230 | 231 | [[package]] 232 | name = "windows-targets" 233 | version = "0.52.0" 234 | source = "registry+https://github.com/rust-lang/crates.io-index" 235 | checksum = "8a18201040b24831fbb9e4eb208f8892e1f50a37feb53cc7ff887feb8f50e7cd" 236 | dependencies = [ 237 | "windows_aarch64_gnullvm", 238 | "windows_aarch64_msvc", 239 | "windows_i686_gnu", 240 | "windows_i686_msvc", 241 | "windows_x86_64_gnu", 242 | "windows_x86_64_gnullvm", 243 | "windows_x86_64_msvc", 244 | ] 245 | 246 | [[package]] 247 | name = "windows_aarch64_gnullvm" 248 | version = "0.52.0" 249 | source = "registry+https://github.com/rust-lang/crates.io-index" 250 | checksum = "cb7764e35d4db8a7921e09562a0304bf2f93e0a51bfccee0bd0bb0b666b015ea" 251 | 252 | [[package]] 253 | name = "windows_aarch64_msvc" 254 | version = "0.52.0" 255 | source = "registry+https://github.com/rust-lang/crates.io-index" 256 | checksum = "bbaa0368d4f1d2aaefc55b6fcfee13f41544ddf36801e793edbbfd7d7df075ef" 257 | 258 | [[package]] 259 | name = "windows_i686_gnu" 260 | version = "0.52.0" 261 | source = "registry+https://github.com/rust-lang/crates.io-index" 262 | checksum = "a28637cb1fa3560a16915793afb20081aba2c92ee8af57b4d5f28e4b3e7df313" 263 | 264 | [[package]] 265 | name = "windows_i686_msvc" 266 | version = "0.52.0" 267 | source = "registry+https://github.com/rust-lang/crates.io-index" 268 | checksum = "ffe5e8e31046ce6230cc7215707b816e339ff4d4d67c65dffa206fd0f7aa7b9a" 269 | 270 | [[package]] 271 | name = "windows_x86_64_gnu" 272 | version = "0.52.0" 273 | source = "registry+https://github.com/rust-lang/crates.io-index" 274 | checksum = "3d6fa32db2bc4a2f5abeacf2b69f7992cd09dca97498da74a151a3132c26befd" 275 | 276 | [[package]] 277 | name = "windows_x86_64_gnullvm" 278 | version = "0.52.0" 279 | source = "registry+https://github.com/rust-lang/crates.io-index" 280 | checksum = "1a657e1e9d3f514745a572a6846d3c7aa7dbe1658c056ed9c3344c4109a6949e" 281 | 282 | [[package]] 283 | name = "windows_x86_64_msvc" 284 | version = "0.52.0" 285 | source = "registry+https://github.com/rust-lang/crates.io-index" 286 | checksum = "dff9641d1cd4be8d1a070daf9e3773c5f67e78b4d9d42263020c057706765c04" 287 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "mcping" 3 | version = "0.2.0" 4 | edition = "2021" 5 | license = "AGPL-3.0-only" 6 | repository = "https://github.com/IoanThomas/mcping" 7 | readme = "README.md" 8 | description = "A simple tool to acquire Minecraft server information using the Server List Ping interface" 9 | 10 | [dependencies] 11 | clap = { version = "4.4", features = ["derive"] } 12 | mc-varint = "0.1" 13 | serde = { version = "1.0", features = ["derive"] } 14 | serde_json = "1.0" 15 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Continuous Integration](https://github.com/IoanThomas/mcping/actions/workflows/ci.yml/badge.svg)](https://github.com/IoanThomas/mcping/actions/workflows/ci.yml) 2 | 3 | # mcping 4 | A simple tool to acquire Minecraft server information using the [Server List Ping interface](https://wiki.vg/Server_List_Ping). 5 | 6 | `mcping` is a command-line tool that allows you to query any Minecraft Java Edition server for the basic information used in the game's server list. 7 | This includes the server description, version, online players, and favicon. 8 | You can configure the application using various command-line arguments. 9 | Run `mcping --help` for full details. 10 | 11 | ## Building 12 | Simply download the repository and execute `cargo build` in the project directory. 13 | A binary should be created in `target/debug`. 14 | 15 | ## License 16 | This project is licensed under the GNU AGPLv3 License - see the [LICENSE](LICENSE) file for details. 17 | -------------------------------------------------------------------------------- /logo.pdn: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/IoanThomas/mcping/a4b71b3518c8e71a302643e3321bf408a6a00b9b/logo.pdn -------------------------------------------------------------------------------- /mcping.iml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /src/arguments.rs: -------------------------------------------------------------------------------- 1 | use clap::Parser; 2 | use std::num::NonZeroU16; 3 | 4 | const DEFAULT_SERVER_PORT: NonZeroU16 = unsafe { NonZeroU16::new_unchecked(25565) }; 5 | 6 | #[derive(Parser)] 7 | #[clap(author, version, about)] 8 | pub struct Arguments { 9 | /// Server IP address or hostname 10 | pub address: String, 11 | 12 | /// Server port 13 | #[clap(short = 'p', long = "port", default_value_t = DEFAULT_SERVER_PORT)] 14 | pub port: NonZeroU16, 15 | 16 | /// List the names of active players if the server provides them 17 | #[clap(short = 'l', long = "players")] 18 | pub list_players: bool, 19 | 20 | /// Print the encoded favicon (very long) if the server has one 21 | #[clap(short = 'f', long = "favicon")] 22 | pub show_favicon: bool, 23 | 24 | /// Print the raw JSON response (ignores other options) 25 | #[clap(short = 'j', long = "json")] 26 | pub json: bool, 27 | } 28 | -------------------------------------------------------------------------------- /src/buffer.rs: -------------------------------------------------------------------------------- 1 | use crate::error::Error; 2 | use crate::parse; 3 | use crate::result::Result; 4 | use mc_varint::{VarInt, VarIntWrite}; 5 | use std::io::Write; 6 | 7 | pub fn write_u16(buffer: &mut Vec, data: u16) -> Result<()> { 8 | buffer 9 | .write_all(&data.to_be_bytes()) 10 | .map_err(Error::BufferWrite) 11 | } 12 | 13 | pub fn write_var_int(buffer: &mut Vec, data: impl Into) -> Result<()> { 14 | buffer 15 | .write_var_int(data.into()) 16 | .map_err(Error::BufferWrite) 17 | } 18 | 19 | pub fn write_string(buffer: &mut Vec, data: impl AsRef) -> Result<()> { 20 | let data = data.as_ref(); 21 | let length = parse::usize_to_i32(data.len())?; 22 | 23 | write_var_int(buffer, length)?; 24 | 25 | buffer 26 | .write_all(data.as_bytes()) 27 | .map_err(Error::BufferWrite) 28 | } 29 | 30 | pub fn write_bytes(buffer: &mut Vec, data: &[u8]) -> Result<()> { 31 | buffer.write_all(data).map_err(Error::BufferWrite) 32 | } 33 | 34 | #[cfg(test)] 35 | mod tests { 36 | use super::*; 37 | 38 | #[test] 39 | fn write_u16_one_byte() { 40 | let mut buffer = vec![]; 41 | write_u16(&mut buffer, 0x002d).expect("failed to write u16"); 42 | 43 | assert_eq!(buffer[0], 0x00); 44 | assert_eq!(buffer[1], 0x2d); 45 | } 46 | 47 | #[test] 48 | fn write_u16_two_bytes() { 49 | let mut buffer = vec![]; 50 | write_u16(&mut buffer, 0x010e).expect("failed to write u16"); 51 | 52 | assert_eq!(buffer[0], 0x01); 53 | assert_eq!(buffer[1], 0x0e); 54 | } 55 | 56 | #[test] 57 | fn write_var_int_small() { 58 | let mut buffer = vec![]; 59 | write_var_int(&mut buffer, 0x8a).expect("failed to write var int"); 60 | 61 | assert_eq!(buffer[0], 0x8a); 62 | } 63 | 64 | #[test] 65 | fn write_var_int_large() { 66 | let mut buffer = vec![]; 67 | write_var_int(&mut buffer, 0x38a).expect("failed to write var int"); 68 | 69 | assert_eq!(buffer[0], 0x8a); 70 | assert_eq!(buffer[1], 0x07); 71 | } 72 | 73 | #[test] 74 | fn write_string_empty() { 75 | let mut buffer = vec![]; 76 | write_string(&mut buffer, "").expect("failed to write string"); 77 | 78 | assert_eq!(buffer[0], 0); 79 | assert_eq!(buffer.get(1), None); 80 | } 81 | 82 | #[test] 83 | fn write_string_short() { 84 | let mut buffer = vec![]; 85 | write_string(&mut buffer, "hello").expect("failed to write string"); 86 | 87 | assert_eq!(buffer[0], 5); 88 | assert_eq!(buffer[1], 104); 89 | assert_eq!(buffer[5], 111); 90 | } 91 | 92 | #[test] 93 | fn write_byte_array() { 94 | let mut buffer = vec![]; 95 | write_bytes(&mut buffer, &[0x12, 0x34, 0x56, 0x78]).expect("failed to write string"); 96 | 97 | assert_eq!(buffer[0], 0x12); 98 | assert_eq!(buffer[1], 0x34); 99 | assert_eq!(buffer[2], 0x56); 100 | assert_eq!(buffer[3], 0x78); 101 | } 102 | } 103 | -------------------------------------------------------------------------------- /src/connection.rs: -------------------------------------------------------------------------------- 1 | use crate::error::Error; 2 | use crate::result::Result; 3 | use mc_varint::{VarInt, VarIntRead}; 4 | use std::io::{Read, Write}; 5 | use std::net::TcpStream; 6 | use std::num::NonZeroU16; 7 | 8 | pub fn create(address: impl AsRef, port: NonZeroU16) -> Result { 9 | TcpStream::connect((address.as_ref(), port.get())).map_err(Error::Connect) 10 | } 11 | 12 | pub fn send_data(connection: &mut TcpStream, data: &[u8]) -> Result<()> { 13 | connection.write_all(data).map_err(Error::ConnectionWrite) 14 | } 15 | 16 | pub fn receive_var_int(connection: &mut TcpStream) -> Result { 17 | connection.read_var_int().map_err(Error::ConnectionRead) 18 | } 19 | 20 | pub fn receive_bytes(connection: &mut TcpStream, count: usize) -> Result> { 21 | let mut json_bytes = vec![0; count]; 22 | connection 23 | .read_exact(&mut json_bytes) 24 | .map_err(Error::ConnectionRead)?; 25 | 26 | Ok(json_bytes) 27 | } 28 | -------------------------------------------------------------------------------- /src/error.rs: -------------------------------------------------------------------------------- 1 | use std::fmt::{Display, Formatter}; 2 | use std::num::TryFromIntError; 3 | use std::string::FromUtf8Error; 4 | use std::{error, fmt, io}; 5 | 6 | #[derive(Debug)] 7 | pub enum Error { 8 | BufferWrite(io::Error), 9 | Connect(io::Error), 10 | ConnectionWrite(io::Error), 11 | ConnectionRead(io::Error), 12 | JsonParse(serde_json::Error), 13 | Utf8Parse(FromUtf8Error), 14 | IntConversion(TryFromIntError), 15 | } 16 | 17 | impl Display for Error { 18 | fn fmt(&self, f: &mut Formatter) -> fmt::Result { 19 | match self { 20 | Self::BufferWrite(error) => write!(f, "failed to write to buffer: {error}"), 21 | Self::Connect(error) => write!(f, "failed to connect to server: {error}"), 22 | Self::ConnectionWrite(error) => write!(f, "failed to send data to server: {error}"), 23 | Self::ConnectionRead(error) => write!(f, "failed to receive data from server: {error}"), 24 | Self::JsonParse(error) => write!(f, "failed to parse JSON response: {error}"), 25 | Self::Utf8Parse(error) => write!(f, "failed to parse UTF-8 string: {error}"), 26 | Self::IntConversion(error) => write!(f, "failed to convert integer: {error}"), 27 | } 28 | } 29 | } 30 | 31 | impl error::Error for Error {} 32 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | pub use crate::error::Error; 2 | pub use crate::result::Result; 3 | 4 | use crate::response::Response; 5 | use mc_varint::VarInt; 6 | use std::num::NonZeroU16; 7 | 8 | pub mod response; 9 | 10 | mod buffer; 11 | mod connection; 12 | mod error; 13 | mod parse; 14 | mod result; 15 | 16 | pub fn get_server_response(address: impl AsRef, port: NonZeroU16) -> Result { 17 | let json_bytes = get_server_response_raw(address, port)?; 18 | 19 | create_response_from_json_bytes(&json_bytes) 20 | } 21 | 22 | pub fn get_server_response_json(address: impl AsRef, port: NonZeroU16) -> Result { 23 | let json_bytes = get_server_response_raw(address, port)?; 24 | 25 | String::from_utf8(json_bytes).map_err(Error::Utf8Parse) 26 | } 27 | 28 | fn get_server_response_raw(address: impl AsRef, port: NonZeroU16) -> Result> { 29 | let address = address.as_ref(); 30 | 31 | let handshake_packet = create_handshake_packet(address, port)?; 32 | let request_packet = create_request_packet()?; 33 | 34 | let mut connection = connection::create(address, port)?; 35 | 36 | connection::send_data(&mut connection, &handshake_packet)?; 37 | connection::send_data(&mut connection, &request_packet)?; 38 | 39 | let _packet_length = connection::receive_var_int(&mut connection)?; 40 | let _packet_id = connection::receive_var_int(&mut connection)?; 41 | let response_length = connection::receive_var_int(&mut connection)?; 42 | 43 | let response_length = parse::i32_to_usize(response_length.into())?; 44 | connection::receive_bytes(&mut connection, response_length) 45 | } 46 | 47 | fn create_handshake_packet(address: impl AsRef, port: NonZeroU16) -> Result> { 48 | const HANDSHAKE_PACKET_ID: i32 = 0; 49 | const UNKNOWN_PROTOCOL_VERSION: i32 = -1; 50 | const STATUS_STATE: i32 = 1; 51 | 52 | let data = create_handshake_data(UNKNOWN_PROTOCOL_VERSION, address, port, STATUS_STATE)?; 53 | create_packet(HANDSHAKE_PACKET_ID, &data) 54 | } 55 | 56 | fn create_request_packet() -> Result> { 57 | const REQUEST_PACKET_ID: i32 = 0; 58 | 59 | create_packet(REQUEST_PACKET_ID, &[]) 60 | } 61 | 62 | fn create_handshake_data( 63 | protocol_version: impl Into, 64 | server_address: impl AsRef, 65 | server_port: NonZeroU16, 66 | next_state: impl Into, 67 | ) -> Result> { 68 | let mut bytes = vec![]; 69 | 70 | buffer::write_var_int(&mut bytes, protocol_version)?; 71 | buffer::write_string(&mut bytes, server_address)?; 72 | buffer::write_u16(&mut bytes, server_port.get())?; 73 | buffer::write_var_int(&mut bytes, next_state)?; 74 | 75 | Ok(bytes) 76 | } 77 | 78 | fn create_packet(id: impl Into, data: &[u8]) -> Result> { 79 | let mut id_bytes = vec![]; 80 | buffer::write_var_int(&mut id_bytes, id)?; 81 | 82 | let packet_length = parse::usize_to_i32(id_bytes.len() + data.len())?; 83 | let mut bytes = vec![]; 84 | 85 | buffer::write_var_int(&mut bytes, packet_length)?; 86 | buffer::write_bytes(&mut bytes, &id_bytes)?; 87 | buffer::write_bytes(&mut bytes, data)?; 88 | 89 | Ok(bytes) 90 | } 91 | 92 | fn create_response_from_json_bytes(json_bytes: &[u8]) -> Result { 93 | serde_json::from_slice(json_bytes).map_err(Error::JsonParse) 94 | } 95 | -------------------------------------------------------------------------------- /src/main.rs: -------------------------------------------------------------------------------- 1 | use crate::arguments::Arguments; 2 | use clap::Parser; 3 | use mcping::response::Description; 4 | use std::borrow::Cow; 5 | 6 | mod arguments; 7 | 8 | fn main() { 9 | let arguments = Arguments::parse(); 10 | 11 | match arguments.json { 12 | true => json_response(arguments), 13 | false => regular_response(arguments), 14 | }; 15 | } 16 | 17 | fn json_response(arguments: Arguments) { 18 | let response = match mcping::get_server_response_json(arguments.address, arguments.port) { 19 | Ok(response) => response, 20 | Err(error) => { 21 | eprintln!("Error: {error}"); 22 | return; 23 | } 24 | }; 25 | 26 | println!("{response}"); 27 | } 28 | 29 | fn regular_response(arguments: Arguments) { 30 | let response = match mcping::get_server_response(arguments.address, arguments.port) { 31 | Ok(response) => response, 32 | Err(error) => { 33 | eprintln!("Error: {error}"); 34 | return; 35 | } 36 | }; 37 | 38 | let description = match response.description { 39 | Description::Text(text) => text, 40 | Description::Chat(chat) => chat.text, 41 | }; 42 | let version_name = response.version.name; 43 | let version_protocol = response.version.protocol; 44 | let players_online = response.players.online; 45 | let players_max = response.players.max; 46 | let players = response.players.sample; 47 | let favicon = response.favicon; 48 | 49 | println!("Description: \"{description}\""); 50 | println!("Version: \"{version_name}\" ({version_protocol})"); 51 | println!("Players: {players_online}/{players_max}"); 52 | 53 | if arguments.list_players { 54 | if let Some(players) = players { 55 | players 56 | .into_iter() 57 | .map(|player| player.name) 58 | .for_each(|name| println!("\t* {name}")); 59 | } 60 | } 61 | 62 | println!("{}", favicon_line(favicon, arguments.show_favicon)); 63 | } 64 | 65 | fn favicon_line(favicon: Option, show_favicon: bool) -> Cow<'static, str> { 66 | match (favicon, show_favicon) { 67 | (None, _) => "Has Favicon: No".into(), 68 | (Some(_), false) => "Has Favicon: Yes".into(), 69 | (Some(favicon), true) => format!("Favicon: {favicon}").into(), 70 | } 71 | } 72 | -------------------------------------------------------------------------------- /src/parse.rs: -------------------------------------------------------------------------------- 1 | use crate::error::Error; 2 | use crate::result::Result; 3 | 4 | pub fn i32_to_usize(value: i32) -> Result { 5 | usize::try_from(value).map_err(Error::IntConversion) 6 | } 7 | 8 | pub fn usize_to_i32(value: usize) -> Result { 9 | i32::try_from(value).map_err(Error::IntConversion) 10 | } 11 | 12 | #[cfg(test)] 13 | mod tests { 14 | use super::*; 15 | 16 | #[test] 17 | fn parse_i32_to_usize() { 18 | let parsed_value = i32_to_usize(42).expect("failed to parse i32"); 19 | assert_eq!(parsed_value, 42); 20 | } 21 | 22 | #[test] 23 | fn parse_usize_to_i32() { 24 | let parsed_value = usize_to_i32(81).expect("failed to parse usize"); 25 | assert_eq!(parsed_value, 81); 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /src/response/chat.rs: -------------------------------------------------------------------------------- 1 | use serde::Deserialize; 2 | 3 | #[derive(Deserialize)] 4 | pub struct Chat { 5 | pub text: String, 6 | } 7 | -------------------------------------------------------------------------------- /src/response/description.rs: -------------------------------------------------------------------------------- 1 | use crate::response::chat::Chat; 2 | use serde::Deserialize; 3 | 4 | #[derive(Deserialize)] 5 | #[serde(untagged)] 6 | pub enum Description { 7 | Text(String), 8 | Chat(Chat), 9 | } 10 | -------------------------------------------------------------------------------- /src/response/mod.rs: -------------------------------------------------------------------------------- 1 | pub use crate::response::chat::Chat; 2 | pub use crate::response::description::Description; 3 | pub use crate::response::player::Player; 4 | pub use crate::response::player_list::PlayerList; 5 | pub use crate::response::version::Version; 6 | 7 | use serde::Deserialize; 8 | 9 | mod chat; 10 | mod description; 11 | mod player; 12 | mod player_list; 13 | mod version; 14 | 15 | #[derive(Deserialize)] 16 | pub struct Response { 17 | pub version: Version, 18 | pub players: PlayerList, 19 | pub description: Description, 20 | pub favicon: Option, 21 | } 22 | -------------------------------------------------------------------------------- /src/response/player.rs: -------------------------------------------------------------------------------- 1 | use serde::Deserialize; 2 | 3 | #[derive(Deserialize)] 4 | pub struct Player { 5 | pub name: String, 6 | pub id: String, 7 | } 8 | -------------------------------------------------------------------------------- /src/response/player_list.rs: -------------------------------------------------------------------------------- 1 | use crate::response::player::Player; 2 | use serde::Deserialize; 3 | 4 | #[derive(Deserialize)] 5 | pub struct PlayerList { 6 | pub max: u32, 7 | pub online: u32, 8 | pub sample: Option>, 9 | } 10 | -------------------------------------------------------------------------------- /src/response/version.rs: -------------------------------------------------------------------------------- 1 | use serde::Deserialize; 2 | 3 | #[derive(Deserialize)] 4 | pub struct Version { 5 | pub name: String, 6 | pub protocol: u32, 7 | } 8 | -------------------------------------------------------------------------------- /src/result.rs: -------------------------------------------------------------------------------- 1 | use crate::error::Error; 2 | use std::result; 3 | 4 | pub type Result = result::Result; 5 | --------------------------------------------------------------------------------