summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFedja Beader <fedja@protonmail.ch>2025-02-22 21:47:36 +0000
committerFedja Beader <fedja@protonmail.ch>2025-02-22 21:47:36 +0000
commit29fc033765b58afecdb60b56f1ee0a1f6e90ff07 (patch)
tree46977dbb0c5deae46a61f1b4791a1144a9a36b82
parent9e8919c573dafd3b571d07a48497b82ca73007f5 (diff)
downloadplus-29fc033765b58afecdb60b56f1ee0a1f6e90ff07.tar.gz
plus-29fc033765b58afecdb60b56f1ee0a1f6e90ff07.tar.bz2
plus-29fc033765b58afecdb60b56f1ee0a1f6e90ff07.tar.xz
plus-29fc033765b58afecdb60b56f1ee0a1f6e90ff07.zip
Update README.md & README
Squashed with: * Add build instructions link * CMake is unsupported (for now) * Change IRC link to irc-only channel. * Update text-only README to match * Make the point clearer. And, Bitbucket is dead by now? * Nah, I'll leave the strange statement about licensing and bad platforms in, for now. It's got a point! * Remove strange statement about licensing and bad platforms * Update note, change in-game support text * RIP FreeNode * Fix fix + add in-game "contact" * Reorganise the support section * Remove some duplicates and reword the command help section (which should probably be removed. This is not the 1985 any more) * Comment out nonfunctional CI badges * reorder builds and CI status * Remove version info.. it's 6 years old anyways. Wait... 6 years since last release?! * Shorten the CI status badges * Update main CI status button to point to pipelines page * Try more compact form on a single line (like before) * Add more direct download links when clicking CI status buttons * Add myself to AUTHORS * Change CI link to point to TMW gitlab + remove undress from help.. players don't need that. * Fix forum link - was pointed to general player talk and not https. **** mana/plus!127
-rw-r--r--AUTHORS1
-rw-r--r--INSTALL10
-rw-r--r--README54
-rw-r--r--README.md66
4 files changed, 66 insertions, 65 deletions
diff --git a/AUTHORS b/AUTHORS
index ffcd00e0d..b3bce7f59 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -6,6 +6,7 @@
Andrei Karas (4144) <akaras inbox ru>
Ben Longbons <b.r.longbons gmail com>
Danil Sagunov (Vasily_Makarov) <danilka.pro gmail com>
+Fedja Beader <fedja protonmail ch>
Helmut Grohne (gnurfk) <helmut subdivi de>
Philippe Groarke (Socapex)
Maarten Vanraes (AL13N) <maarten.vanraes gmail com>
diff --git a/INSTALL b/INSTALL
index 486572881..67e1e9d16 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,8 +1,8 @@
-How to compile and run ManaVerse on your GNU/Linux Box
-=================================================
+How to compile and run ManaVerse on your GNU+Linux Box
+======================================================
Homepage: http://manaverse.germantmw.de/
-IRC: irc.libera.chat:6697 (TLS) / #themanaworld-dev
+IRC: irc.libera.chat:6697 (TLS) / #themanaworld-irc
1) Requirements
2) Compiling And Installing ManaVerse
@@ -43,7 +43,7 @@ you to figure this out.
2. Compiling And Installing ManaVerse
-====================================
+=====================================
Building with GNU Autotools
@@ -67,7 +67,7 @@ a different prefix to configure as usual.
Rebuild the executable from scratch using "make clean" and then "make".
-Building with CMake
+Building with CMake (unsupported)
1) Create a directory for building and change to that directory.
2) Configure the build with: cmake <path_to_source>
diff --git a/README b/README
index 712cbc30c..7e060e798 100644
--- a/README
+++ b/README
@@ -1,16 +1,13 @@
THE MANA VERSE CLIENT
-===============
+=====================
- Version: 1.0 Date: 2019-03-23
+ Builds:
+ ManaVerse CI: https://git.themanaworld.org/mana/plus/-/pipelines
+ Windows: https://git.themanaworld.org/mana/docker-windows-builder/-/jobs/artifacts/master/browse?job=mxe_gcc5
+ AppImg: https://git.themanaworld.org/mana/appimg-builder/-/jobs/artifacts/master/browse?job=x86_64-AppImage
+ deb: https://git.themanaworld.org/mana/appimg-builder/-/jobs/artifacts/master/browse?job=deb_pkg
- Build status:
- ManaVerse CI: https://git.themanaworld.org/mana/plus/badges/master/pipeline.svg
- Windows: https://git.themanaworld.org/mana/docker-windows-builder/badges/master/pipeline.svg
- AppImg: https://git.themanaworld.org/mana/appimg-builder/badges/master/pipeline.svg
- deb: https://git.themanaworld.org/mana/appimg-builder/badges/master/pipeline.svg
- Coverage: https://git.themanaworld.org/mana/plus/badges/master/coverage.svg
- Doxygen: http://stats.manaplus.org/docs/index.html
- Coverity: https://scan.coverity.com/projects/manaplus
+ See file INSTALL for build instructions.
Development team:
- See AUTHORS file for a list
@@ -114,18 +111,17 @@ Actions:
- /away MSG set away mode.
- /follow NICK start follow mode.
- /imitation NICK start imitation mode.
-- /heal NICK heal nick.
+- /heal NICK heal somebody by nickname
- /move X Y move to X,Y position in short distance.
- /navigate x y move to position x,y in current map in any distance.
-- /mail NICK MSG send offline message to NICK. Working only in tmw server.
+- /mail NICK MSG send offline message to NICK. Working only in servers with mail support.
- /disconnect quick disconnect from server.
- /attack attack target.
-- /undress NICK remove all clothes from nick. Local effect only.
Trade:
- /trade NICK start trade with nick.
-- /priceload load shop price from disc.
-- /pricesave save shop price to disc.
+- /priceload load shop price from disk.
+- /pricesave save shop price to disk.
Player relations:
- /ignore NICK add nick to ignore list.
@@ -142,35 +138,35 @@ Player relations:
Debug:
- /who print online players number to chat.
- /all show visible beings list in debug tab.
-- /where print current player position to chat.
+- /where Show map and coordiantes of your avatar
- /cacheinfo show text cache info.
- /dirs show client directories in debug window.
Other:
- /help Displays the list of commands
-- /announce broadcasts a global msg(Gm Cammand only)
-- /who shows how many players are online
-- /where displays the map name your currently on
+- /announce (GM) broadcasts a global msg
4. Support
----------
-If you're having issues with this client, feel free to report them to us.
-You can report on forum (http://forums.themanaworld.org/viewforum.php?f=12),
-bugtracker (https://git.themanaworld.org/mana/plus/issues/) or other project
-networks such as IRC.
+Please report any issues you are having with this client.
+You can report them at:
+
+- bugtracker: https://git.themanaworld.org/mana/plus/issues/
+- forum: http://forums.themanaworld.org/viewforum.php?f=56
+- IRC: https://web.libera.chat/?channels=themanaworld-irc
+- Discord https://shields.io/discord/775612630836445206.svg?label=Discord
+- In game: to game masters, developers or #world channel.
If you have feedback about a specific game that uses the ManaVerse client, be sure
-to contact the developers of the game instead.
+to instead contact the developers of that game.
5. Licenses
-----------
-All code in this repository under GPL 2+ license. Art can be under CC-BY-SA or GPL 2+.
+All code in this repository is under GPL 2+ license. Art can be under CC-BY-SA or GPL 2+.
-Github, Bitbucked or other non free hostings may use strange TOS what may violate this licenses.
-If any of this hostings want to violate GPL or/and CC-BY-SA licenses,
-they not have any rights to do so.
-This hostings have rights to remove ManaVerse repositories if they want violate given licenses.
+GitHub or other non-free hosting providers may use strange Terms of Service that may violate these licenses.
+If any of their terms violate these licenses then these providers should remove ManaVerse repositories from their platforms.
ManaVerse is a fork of ManaPlus, the main repository of the latter is hosted on https://gitlab.com/manaplus/manaplus/
diff --git a/README.md b/README.md
index a8bf2f628..639723c23 100644
--- a/README.md
+++ b/README.md
@@ -2,16 +2,15 @@
![ManaVerse logo](data/icons/manaverse.png)
-Version: 1.9.3.23 Date: 2019-03-23
-
-### Build status
-
- - ManaVerse CI: [![gitlab build status](https://git.themanaworld.org/mana/plus/badges/master/pipeline.svg?key_text=master)](https://git.themanaworld.org/mana/plus/commits/master)
-
- - Downloads: [![gitlab windows build](https://git.themanaworld.org/mana/docker-windows-builder/badges/master/pipeline.svg?key_text=Windows+Build&key_width=150px)](https://gitlab.com/themanaworld/manaplus/docker-windows-builder/commits/master),
- [![gitlab appimg build](https://git.themanaworld.org/mana/appimg-builder/badges/master/pipeline.svg?key_text=AppImg+Build&key_width=150px)](https://git.themanaworld.org/mana/appimg-builder/commits/master),
- [![gitlab .deb build](https://git.themanaworld.org/mana/appimg-builder/badges/master/pipeline.svg?key_text=.deb+Build&key_width=150px)](https://git.themanaworld.org/mana/appimg-builder/commits/master)
-
+### Downloads and Build status (click on badge)
+<!-- can't link to job pages directly (https://gitlab.com/gitlab-org/gitlab/-/issues/19845#note_435733246)
+ but the browse link has a job page reference and a download button. -->
+ <!-- direct link: */-/jobs/artifacts/master/download?job=mxe_gcc5 -->
+ [![gitlab windows build](https://git.themanaworld.org/mana/docker-windows-builder/badges/master/pipeline.svg?key_text=Windows+Build&key_width=100px)](https://git.themanaworld.org/mana/docker-windows-builder/-/jobs/artifacts/master/browse?job=mxe_gcc5)
+ [![gitlab appimg build](https://git.themanaworld.org/mana/appimg-builder/badges/master/pipeline.svg?key_text=AppImg+Build&key_width=100px)](https://git.themanaworld.org/mana/appimg-builder/-/jobs/artifacts/master/browse?job=x86_64-AppImage)
+ [![gitlab .deb build](https://git.themanaworld.org/mana/appimg-builder/badges/master/pipeline.svg?key_text=.deb+Build&key_width=100px)](https://git.themanaworld.org/mana/appimg-builder/-/jobs/artifacts/master/browse?job=deb_pkg)
+
+ [![gitlab build status](https://git.themanaworld.org/mana/plus/badges/master/pipeline.svg?key_text=CI%20on%20master&key_width=100px)](https://git.themanaworld.org/mana/plus/-/pipelines)
<!--
Cicle CI: [![CircleCI](https://circleci.com/gh/ManaPlus/ManaPlus/tree/master.svg?style=svg)](https://circleci.com/gh/ManaPlus/ManaPlus/tree/master)
@@ -23,12 +22,16 @@ Azure CI: [![Build Status macosx](https://dev.azure.com/manaplus/ManaPlus/_apis/
[![Build Status windows](https://dev.azure.com/manaplus/ManaPlus/_apis/build/status/ManaPlus%20main)](https://dev.azure.com/manaplus/ManaPlus/_build/latest?definitionId=1)
-->
- - Coverage: ![coverage report](https://git.themanaworld.org/mana/plus/badges/master/coverage.svg) <!-- no pipeline rn -->
+ ![Build Instructions](INSTALL)
- - Doxygen: ![doxygen](https://img.shields.io/badge/Docs-Doxygen-blue.svg) <!-- no pipeline rn -->
+<!-- no pipelines rn :(
- - Coverity: ![coverity](https://scan.coverity.com/projects/318/badge.svg) <!-- no pipeline rn -->
+ - Coverage: ![coverage report](https://git.themanaworld.org/mana/plus/badges/master/coverage.svg)
+ - Doxygen: ![doxygen](https://img.shields.io/badge/Docs-Doxygen-blue.svg)
+
+ - Coverity: ![coverity](https://scan.coverity.com/projects/318/badge.svg)
+-->
### Development team:
- See [AUTHORS](AUTHORS) file for a list
@@ -129,18 +132,17 @@ Whispers:
- /away MSG set away mode.
- /follow NICK start follow mode.
- /imitation NICK start imitation mode.
-- /heal NICK heal nick.
+- /heal NICK heal somebody by nickname
- /move X Y move to X,Y position in short distance.
- /navigate x y move to position x,y in current map in any distance.
-- /mail NICK MSG send offline message to NICK. Working only in tmw server.
+- /mail NICK MSG send offline message to NICK. Working only in servers with mail support.
- /disconnect quick disconnect from server.
- /attack attack target.
-- /undress NICK remove all clothes from nick. Local effect only.
### Trade:
- /trade NICK start trade with nick.
-- /priceload load shop price from disc.
-- /pricesave save shop price to disc.
+- /priceload load shop price from disk.
+- /pricesave save shop price to disk.
### Player relations:
- /ignore NICK add nick to ignore list.
@@ -157,32 +159,34 @@ Whispers:
### Debug:
- /who print online players number to chat.
- /all show visible beings list in debug tab.
-- /where print current player position to chat.
+- /where Show map and coordiantes of your avatar
- /cacheinfo show text cache info.
- /dirs show client directories in debug window.
### Other:
- /help Displays the list of commands
-- /announce broadcasts a global msg(Gm Cammand only)
-- /who shows how many players are online
-- /where displays the map name your currently on
+- /announce (GM) broadcasts a global msg
## 4. Support
-If you're having issues with this client, feel free to report them to us.
-You can report on [![forum](https://img.shields.io/badge/forum-forums.themanaworld.org-yellow.svg)](http://forums.themanaworld.org/viewforum.php?f=12),
-[![Issues](https://badgen.net/gitlab/open-issues/themanaworld%2fmanaplus/manaplus?label=Issues)](https://git.themanaworld.org/mana/plus/issues/),
-[![IRC](https://img.shields.io/badge/IRC-FreeNode/germantmw-yellow.svg)](web.libera.chat/?channels=themanaworld) or
-![discord](https://shields.io/discord/775612630836445206.svg?label=Discord)
+Please report any issues you are having with this client.
+You can report them at:
+
+<!-- Can't easily get a badge for *open* issues from GitLab itself: https://stackoverflow.com/questions/48829255/gitlab-count-total-number-of-issues -->
+- ![GitLab Issues](https://img.shields.io/gitlab/issues/open/mana%2Fplus?gitlab_url=https%3A%2F%2Fgit.themanaworld.org) (if you have a TMW GitLab account)
+- [![forum](https://img.shields.io/badge/forum-forums.themanaworld.org-yellow.svg)](https://forums.themanaworld.org/viewforum.php?f=56)
+- [![IRC](https://img.shields.io/badge/IRC-Libera%2Fthemanaworld--irc-yellow)](https://web.libera.chat/?channels=themanaworld-irc)
+- ![Discord](https://shields.io/discord/775612630836445206.svg?label=Discord)
+- In game: to game masters, developers or #world channel.
If you have feedback about a specific game that uses the ManaVerse client, be sure
-to contact the developers of the game instead.
+to instead contact the developers of that game.
## 5. Licenses
-All code in this repository under ![GPL 2+](https://img.shields.io/badge/license-GPL2+-blue.svg) license. Art can be under ![CC-BY-SA](https://img.shields.io/badge/license-CC_BY_SA-blue.svg) or ![GPL 2+](https://img.shields.io/badge/license-GPL2+-blue.svg).
+All code in this repository is under ![GPL 2+](https://img.shields.io/badge/license-GPL2+-blue.svg) license. Art can be under ![CC-BY-SA](https://img.shields.io/badge/license-CC_BY_SA-blue.svg) or ![GPL 2+](https://img.shields.io/badge/license-GPL2+-blue.svg).
-Github, Bitbucked or other non free hostings may use strange TOS what may violate this licenses. If any of this hostings want to violate GPL or/and CC-BY-SA licenses,
-they not have any rights to do so. This hostings have rights to remove ManaVerse repositories if they want violate given licenses.
+GitHub or other non-free hosting providers may use strange Terms of Service that may violate these licenses.
+If any of their terms violate these licenses then these providers should remove ManaVerse repositories from their platforms.
ManaVerse is a fork of ManaPlus, the main repository of the latter is hosted on [gitlab.com](https://gitlab.com/manaplus/manaplus/)