README.txt 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. SDLPAL
  2. ======
  3. SDLPAL is an SDL-based reimplementation of the classic Chinese-language RPG
  4. "Xian Jian Qi Xia Zhuan" (also known as PAL or Legend of Sword and Fairy).
  5. LICENSE
  6. =======
  7. SDLPAL is originally created by Wei Mingzhi from 2009.
  8. Copyright (c) 2009-2011 Wei Mingzhi <whistler_wmz@users.sf.net>.
  9. Copyright (c) 2011-2015 SDLPAL development team.
  10. All rights reserved.
  11. SDLPAL is distributed under the terms of GNU General Public License, version 3
  12. (or any later version) as published by the Free Software Foundation. See
  13. gpl.txt for details.
  14. Many of the ideas of this program are based on documents from PAL
  15. Research Project (https://github.com/palxex/palresearch), and portions of the
  16. code are based on the work done by Baldur and louyihua.
  17. The getopt.c file is based on source code in OpenBSD.
  18. The resampler code is based on the code in Kode54's foo_input_adplug project
  19. (https://github.com/kode54/foo_input_adplug).
  20. This program made extensive use of the following libraries:
  21. SDL (http://www.libsdl.org/)
  22. Adplug (http://adplug.sourceforge.net/)
  23. SDL_mixer (http://www.libsdl.org/projects/SDL_mixer/)
  24. libmad (http://www.underbit.com/products/mad/)
  25. libogg & libvorbis (http://www.vorbis.com/)
  26. And some of the OPL simulation cores this program used are from the DOSBOX
  27. project (http://www.dosbox.com).
  28. Please see authors.txt for additional authors.
  29. This program does NOT include any code or data files of the original game,
  30. which is proprietary and copyrighted by SoftStar Inc.
  31. COMPILE UNDER WINDOWS
  32. =====================
  33. The following compilers/IDEs are supported under Windows:
  34. 1) Microsoft Visual Studio 2013 or higher (official)
  35. 2) Dev-C++ 4.9.9.2 (unofficial)
  36. 3) Open Watcom 1.7 (unofficial)
  37. To compile, open the respective project file (sdlpal.sln, sdlpal.dev, or
  38. sdlpal.wpj). You need to have SDL 2.0 development files installed.
  39. COMPILE UNDER GNU/LINUX
  40. =======================
  41. To compile, type:
  42. make
  43. You need to have SDL 2.0 development files installed. The compiled executable
  44. should be generated with the filename 'sdlpal' at the top directory of source
  45. files.
  46. SDLPAL should also be able to compile and run under other UNIX-like systems,
  47. however it's not tested.
  48. COMPILE UNDER MAC OS X
  49. ======================
  50. To compile, open the project Pal.xcodeproj with Xcode, and click Build. You
  51. need to have SDL framework installed at /Library/Frameworks.
  52. The compiled bundle should work as a "universal" binary which works on both
  53. Intel and PowerPC.
  54. CLASSIC BUILD
  55. =============
  56. By default, SDLPAL uses a revised battle system which is more exciting yet
  57. somewhat harder than the original game. If you prefer the traditional
  58. turn-based battle system, uncomment the following line:
  59. //#define PAL_CLASSIC 1
  60. in the file common.h and recompile. This will build a "classic" build which is
  61. 100% the same as the original game.
  62. RUNNING THE GAME
  63. ================
  64. The data files required for running the game are not included with the source
  65. package due to copyright issues. You must obtain them from the original CD.
  66. To run the game, copy all the files on the original CD to a directory, then
  67. copy the SDLPAL executable to the same directory, and run the executable.
  68. Note that the filenames of data files should be in lower-case under GNU/Linux
  69. (or other UNIX-like operating systems).
  70. CONFIGURE THE GAME
  71. ==================
  72. PAL has several variants using different and incompatible resource files. Now
  73. SDLPAL supports several configuration options for supporting such variants.
  74. To set these configuration options, create a file named as 'sdlpal.cfg' (make
  75. sure to use lower-case file name in UNIX-like operating systems) in the game
  76. directory created by the above step. If no configuration file exists, SDLPAL
  77. uses default values that supports the original resources of DOS version.
  78. Please refer to the 'sdlpal.cfg.example' for configuration file format.
  79. -END OF FILE-