README.txt 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  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-2016 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 resampler code is based on the code in Kode54's foo_input_adplug project
  18. (https://github.com/kode54/foo_input_adplug).
  19. This program made extensive use of the following libraries:
  20. SDL (http://www.libsdl.org/)
  21. Adplug (http://adplug.sourceforge.net/)
  22. SDL_mixer (http://www.libsdl.org/projects/SDL_mixer/)
  23. libmad (http://www.underbit.com/products/mad/)
  24. libogg & libvorbis (http://www.vorbis.com/)
  25. FLTK (http://www.fltk.org)
  26. And some of the OPL simulation cores this program used are from the DOSBOX
  27. project (http://www.dosbox.com) and MAME project (http://mamedev.org/).
  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 FOR WINDOWS
  32. ===================
  33. The Microsoft Visual Studio 2013 or higher is supported under Windows.
  34. To compile the WIN32 desktop version, open the Visual Studio project file
  35. 'sdlpal.sln' under the 'win32' directory.
  36. To comiple the WinRT version, open one of the project files (SDLPal.UWP.sln,
  37. SDLPal.Windows.sln, SDLPal.WindowsPhone.sln) under the 'winrt' directory.
  38. Please note that, to compile the UWP version, Visual Studio 2015 or higher
  39. is required.
  40. For all situations, you need to have SDL 2.0 development or source files
  41. installed at the SDL2 directory under the source tree.
  42. COMPILE FOR GNU/LINUX OR UNIX
  43. =============================
  44. To compile, type:
  45. cd unix
  46. make
  47. You need to have SDL 2.0 development files installed. The compiled executable
  48. should be generated with the filename 'sdlpal' at the current directory. By
  49. default, SDLPAL uses the FLTK library to provide setting GUI at launch. If you
  50. do not want to use the library, please define the macro 'PAL_NO_LAUNCH_UI' in
  51. the makefile.
  52. SDLPAL should also be able to compile and run under other UNIX-like systems,
  53. however it's not tested.
  54. COMPILE FOR MAC OS X
  55. ====================
  56. To compile, open the project Pal.xcodeproj with Xcode, and click Build. You
  57. need to have SDL framework installed at /Library/Frameworks.
  58. COMPILE FOR IOS
  59. ===============
  60. You need to have SDL2 source extracted in the SDL2 folder.To compile,
  61. open the project iOS/SDLPAL/SDLPal.xcodeproj with Xcode, and click Build.
  62. COMPILE FOR ANDROID
  63. ===================
  64. You need to have SDL2 source extracted in the SDL2 folder.
  65. To compile, type:
  66. cd android/jni
  67. ndk-build
  68. cd ..
  69. ant debug
  70. COMPILE FOR NINTENDO 3DS
  71. ========================
  72. To compile, type:
  73. cd 3ds
  74. make
  75. make cia
  76. You need to have DevkitPro ARM and SDL 1.2 for 3DS portlib installed. The
  77. compiled executable should be generated with the filename 'sdlpal' at the
  78. current directory.
  79. COMPILE FOR OTHER PLATFORMS
  80. ===========================
  81. To be written.
  82. CLASSIC BUILD
  83. =============
  84. By default, SDLPAL uses a revised battle system which is more exciting yet
  85. somewhat harder than the original game. If you prefer the traditional
  86. turn-based battle system, uncomment the following line:
  87. //#define PAL_CLASSIC 1
  88. in the file common.h and recompile. This will build a "classic" build which is
  89. 100% the same as the original game.
  90. RUNNING THE GAME
  91. ================
  92. The data files required for running the game are not included with the source
  93. package due to copyright issues. You must obtain them from the original CD.
  94. To run the game, copy all the files on the original CD to a directory, then
  95. copy the SDLPAL executable to the same directory, and run the executable.
  96. Note that the filenames of data files should be in lower-case under GNU/Linux
  97. (or other UNIX-like operating systems).
  98. CONFIGURE THE GAME
  99. ==================
  100. PAL has several variants using different and incompatible resource files. Now
  101. SDLPAL supports several configuration options for supporting such variants.
  102. To set these configuration options, create a file named as 'sdlpal.cfg' (make
  103. sure to use lower-case file name in UNIX-like operating systems) in the game
  104. directory created by the above step. If no configuration file exists, SDLPAL
  105. uses default values that supports the original resources of DOS version.
  106. Please refer to the 'sdlpal.cfg.example' for configuration file format.
  107. -END OF FILE-