My goal is to allow the user to do pretty much anything that can be done in game, over a web browser (except for BBS missions and stuff like that).
For more details on what X3RPM is, see the original thread http://forum.egosoft.com/viewtopic.php?t=104941 (And yes, I have gotten permission off nuclear_eclipse to release this, in fact most of the credit goes to him, for his awesome work.)
X3RPM is available to download here: http://www.doomed.profusehost.net/x3rpm.html
Post any bugs or feature requests (within reason...) here:
http://trac2.assembla.com/x3rpm/wiki
Just create a new ticket - give as much details as possible.
See below for a list of changes.
I've also made a little utility for anyone who wants to use X3RPM on the same machine that X3 is running on. It's a bit of a hack, but it works...
I should note that I managed to forget the default username and password!
Default username: x3rpm
Default password: password
README:
Code: Select all
****** X3RPM - X3 Remote Property Management ******
Created by: John Reese (Nuclear_Eclipse)
Modified by: Doomed
Current Version: 0.8 - 30/11/2007
***************************************************
DISCLAIMER:
I have not tested X3RPM for any extended period of time and cannot be responsible for any undesired consaquences.
As with everything, use at your own risk.
NOTE:
Any statements on the performance of X3RPM are based on my experiences alone.
My computer is fairly old now, so you may get better performance if you've got a better PC.
My PC Specs are:
AMD Athlon 64 3000+ @ 2.16GHz
Gigabyte K8NF-9 Rev 1
1GB DDR400
NVIDIA 6600 256MB @ 365/565
200GB Seagate 7200.8 SATA
***************************************************
(This is all taken mostly from original readme):
What It Is:
X3RPM is a remote management utility that allows a
user to view statistics, property lists, galaxy and
sector maps, and more from any web browser with
access to the internet. The ability to remotely
command and manage ships and stations is also a
major feature of the RPM suite. All information is
updated live from the current X3 session, and is
fed to the website for instant updates.
X3RPM utilizes two technologies to deliver content:
* Apache 2.0.61
* PHP 5.2.4
It creates a web server on the host machine, which listens for connections on port 7800. It then uses php pages to communicate with special scripts in X3 to deliver live information.
As of version 0.8, X3RPM no longer requires the user to run a 'X3 RPM Host' command on a ship. X3RPM is now an AL Plugin and can be turned on and off through the AL Plugins menu (Options->Gameplay->Artificial Life Settings).
NOTE: The property, universe, and sector pages require a running copy of X3 in order to function.
The Statistics page only requires the game to have run with the X3RPM plugin activated to display statistics.
***************************************************
NEW Features, as of 0.8
- X3RPM converted to AL Script - No longer need to run a command on a ship
- Allows X3 to run while minimized - use X3RPM on the same computer as X3 (See further down, under "x3hide")
- Ability to trade with stations
- Statistics are now live
- Added Race Ranks to statistics page
- Universe Map now highlights all player ships, including those that are docked
- Player Ship is highlighted as green on universe map
- Change and preview CSS themes through X3RPM
- Change X3 Directory through X3RPM
- Friends list - Username, email and address to their X3RPM page. Show your empire to everyone!
***************************************************
Features:
- View game statistics
- View a list of player-owned property
- View a map of the currently explored universe
- View sector's listing of ships and stations
- View detailed information for stations, including
monetary data, products and resources, docked
and owned ships, and more.
- View detailed information for ships, including
pilot, sector, homebase, performance stats,
freight bay contents, current command status,
docked, and owned ships.
- Change station and ship names and settings
- Give commands to ships for just about anything
- View X3RPM from any internet capable PC
- No need to have X3 installed on remote systems
- Compatible with any X3 modification or galaxy
- Allows for changeable layouts and themes a la CSS
***************************************************
Limitations:
- Finding ships can be troublesome if the ship
changes sectors. Limited searching is in place,
but if the ship has moved more than a couple
sectors away since the last update, returning to
the property screen will be necessary to locate
the ship once more.
***************************************************
Planned Features:
- Decent documentation
- Some form of signature on statistics page
- Improved sector map display (Possibly some sort of representation using tables, similar to the universe map)
- Station/Complex building
- Some form of shoutbox/forum for users to communicate with.
***************************************************
Known Issues:
- Property Screen is INCREDIBLY slow to update with a reasonable sized empire.
Mine takes over 15 seconds to load (and loading is unreliable) and my
empire is only tiny compared to other people's.
This is due to the sheer amount of information being transferred from X3.
Hopefully the next version should contain a workaround for this.
- Error message containing:
"Warning: unlink(C:/X3REUNION/log07999.txt) [function.unlink]: Permission denied in C:\X3REUNION\x3rpm\htdocs\inc\func.php on line 86"
or similar.
This is due to the way Windows handles file protection, as explained here: http://forum.egosoft.com/viewtopic.php?p=1294333#1294333
***************************************************
Installation:
- Extract the .rar contents into your X3 Reunion
folder. You may move the 'x3rpm' folder to
anywhere you prefer at this point ONLY.
- Run the 'x3rpm/x3rpm-install.bat' file to create
a service for the X3RPM program to start on its
own when windows starts
(Alternativly, create a shortcut to the "x3rpm-start.bat" file
and run it instead, to avoid having to make a service,although
making a service is easier).
- Run the 'x3rpm/x3rpm-start.bat' to start X3RPM
(This is only required the first time, or if you
specifically stop the X3RPM service later)
- Open up your router/firewall/NAT for port 7800
- browse to http://localhost:7800 or from outside your home network, http://<youripaddress>:7800
- If you have X3 in a non-standard directory (other than C:\Program Files\Deepsilver), you will have to change
the X3 directory. X3RPM will display errors that a file cannot be found, but ignore them and navigate to
the settings tab. There you can change the X3 directory.
- Now you're done!
***************************************************
Using X3RPM:
- You must have the X3RPM service running to use
X3RPM.
- Make sure you have properly set X3RPM to point to your
X3 directory
- Start X3
- Make sure that X3RPM is activated in Artificial Life Settings
- You're done. You can now view your X3RPM pages
from a different computer.
- The default username/password combination is
'x3rpm'/'password' - You can change the password
via the 'x3rpm/x3rpm-change-password.bat' file,
which will then require a restart of X3RPM.
***************************************************
x3hide:
DISCLAIMER:
This program is still fairly untested - use at your own risk.
When running X3RPM on the same computer as X3, you will find that the only way for the not static pages to work
(ie, pages that are not the statistics page) you have to have the window focus on X3. Otherwise the game will pause
and X3RPM will not work. This seperate utility written in C, allows you to run X3 in the background so you are free to
do other things (like use X3RPM).
Instructions:
- navigate to the x3hide folder and then run the "open cmd" batch file
- at the command prompt, type "x3hide hide"
- X3 will quickly minimize and restore a couple of times, then disappear from the taskbar
- Although you can't see X3 in the taskbar, remember X3 IS STILL RUNNING, it's just in the background
- When you want to close X3, go back to the "open cmd" batch file and type in the command prompt "x3hide show"
- X3 will return to the taskbar and you can close it normally.
NOTE:
Using x3hide is the same as playing X3 constantly, that is it uses all the resources that X3 would while you were in game.
This means that the computer become slow or stop responding completely. For this reason, it is not recommended to use this
on older computers. On my computer, the slowdown is quite noticeable, but is still very usable. Your experience may differ and I cannot guarentee that it will function as you wish.
***************************************************
Uninstallation:
- Turn off X3RPM in the Artificial Life settings
- Run the 'x3rpm/x3rpm-stop.bat' and
'x3rpm/x3rpm-uninstall.bat' programs
- remove the 'x3rpm' directory
- remove 't/447850.xml' and 't/447851.xml'
- remove all *.nuke.rpm.* scripts
- remove al.rpm.main script and setup.nuke.rpm
***************************************************
Compatibility:
- Uses 447850.xml and 447851.xml text files
- Uses 7850 and 7851 text pages
- Uses log07850.txt thru 07999.txt log files
- Should work with most mods and scripts fine.
***************************************************
History:
- v0.8 - 2007-11-30 - First release
- Now uses Apache 2.0.61 and PHP 5.2.4
- Converted to AL script
- Settings screen - change CSS and X3 Directory
- Universe screen now highlights all player ships and playerships is highlighted in green
- Added friends list (based on sqlite)
- Added Race Rank
- Statistics are now live
- v0.7 - 2005-12-08 - nuclear_eclipse Public release
***************************************************