【转】用Python和Pygame写游戏-从入门到精通（py2exe篇）

crossin先生

转自 目光博客：http://eyehere.net/2011/python-pygame-novice-professional-py2exe/

这次不是直接讲解下去，而是谈一下如何把我们写的游戏做成一个exe文件，这样一来，用户不需要安装python就可以玩了。扫清了游戏发布一大障碍啊！

perl，python，java等编程语言，非常好用，语法优美，功能强大；VB啥的，功能上编写的时候总有那么点不舒服的地方（个人见解），可是用户和受众极多，一个很大的原因就是：VB是微软提供的，可以很方便的编译（伪？）生成exe文件。有了exe，所有的Windows都能方便的使用了。

我们不能指望用户在玩我们的游戏之前都安装一个python和pygame，甚至还要装一些其他额外的库（比如上一章的gameobjects），这会吓退99%以上的人……所以把我们的游戏打包（注意是打包而不是编译，python毕竟是脚本程序）成一个可执行文件势在必行。

perl有perlcc（免费高效但配置极其复杂），perlapp（简单效果也不错但是收费）等工具；而对python来说，py2exe是不二之选，首先是免费的，而且压出来的文件，虽然不能和编译软件相比，还是不错的了。

到py2exe的官方网站下载安装包，注意要对应自己的python版本。

py2exe是需要写一个脚本进行打包的操作，使用下面这个专为pygame写就的脚本（参考py2exe官方），可以极大的方便打包操作，注意在使用前修改BuildExe里的各个参数。

1. #!python
   
2. # -*- coding: gb2312 -*-
   
3. 
   
4. # 这个脚本专为pygame优化，使用py2exe打包代码和资源至dist目录
   
5. #
   
6. # 使用中若有问题，可以留言至：
   
7. #  //eyehere.net/2011/python-pygame-novice-professional-py2exe/
   
8. #
   
9. # 安装需求:
   
10. #         python, pygame, py2exe 都应该装上
    
11. 
    
12. # 使用方法:
    
13. #         1: 修改此文件，指定需要打包的.py和对应数据
    
14. #         2: python pygame2exe.py
    
15. #         3: 在dist文件夹中，enjoy it~
    
16. 
    
17. try:
    
18.     from distutils.core import setup
    
19.     import py2exe, pygame
    
20.     from modulefinder import Module
    
21.     import glob, fnmatch
    
22.     import sys, os, shutil
    
23. except ImportError, message:
    
24.     raise SystemExit,  "Sorry, you must install py2exe, pygame. %s" % message
    
25. 
    
26. # 这个函数是用来判断DLL是否是系统提供的（是的话就不用打包）
    
27. origIsSystemDLL = py2exe.build_exe.isSystemDLL
    
28. def isSystemDLL(pathname):
    
29.     # 需要hack一下，freetype和ogg的dll并不是系统DLL
    
30.     if os.path.basename(pathname).lower() in ("libfreetype-6.dll", "libogg-0.dll", "sdl_ttf.dll"):
    
31.         return 0
    
32.     return origIsSystemDLL(pathname)
    
33. # 把Hack过的函数重新写回去
    
34. py2exe.build_exe.isSystemDLL = isSystemDLL
    
35. 
    
36. # 这个新的类也是一个Hack，使得pygame的默认字体会被拷贝
    
37. class pygame2exe(py2exe.build_exe.py2exe):
    
38.     def copy_extensions(self, extensions):
    
39.         # 获得pygame默认字体
    
40.         pygamedir = os.path.split(pygame.base.__file__)[0]
    
41.         pygame_default_font = os.path.join(pygamedir, pygame.font.get_default_font())
    
42.         # 加入拷贝文件列表
    
43.         extensions.append(Module("pygame.font", pygame_default_font))
    
44.         py2exe.build_exe.py2exe.copy_extensions(self, extensions)
    
45. 
    
46. # 这个类是我们真正做事情的部分
    
47. class BuildExe:
    
48.     def __init__(self):
    
49.         #------------------------------------------------------#
    
50.         ##### 对于一个新的游戏程序，需要修改这里的各个参数 #####
    
51.         #------------------------------------------------------#
    
52. 
    
53.         # 起始py文件
    
54.         self.script = "MyGames.py"
    
55.         # 游戏名
    
56.         self.project_name = "MyGames"
    
57.         # 游戏site
    
58.         self.project_url = "about:none"
    
59.         # 游戏版本
    
60.         self.project_version = "0.0"
    
61.         # 游戏许可
    
62.         self.license = "MyGames License"
    
63.         # 游戏作者
    
64.         self.author_name = "xishui"
    
65.         # 联系电邮
    
66.         self.author_email = "blog@eyehere.net"
    
67.         # 游戏版权
    
68.         self.copyright = "Copyright (c) 3000 xishui."
    
69.         # 游戏描述
    
70.         self.project_description = "MyGames Description"
    
71.         # 游戏图标(None的话使用pygame的默认图标)
    
72.         self.icon_file = None
    
73.         # 额外需要拷贝的文件、文件夹(图片，音频等)
    
74.         self.extra_datas = []
    
75.         # 额外需要的python库名
    
76.         self.extra_modules = []
    
77.         # 需要排除的python库
    
78.         self.exclude_modules = []
    
79.         # 额外需要排除的dll
    
80.         self.exclude_dll = ['']
    
81.         # 需要加入的py文件
    
82.         self.extra_scripts = []
    
83.         # 打包Zip文件名(None的话，打包到exe文件中)
    
84.         self.zipfile_name = None
    
85.         # 生成文件夹
    
86.         self.dist_dir ='dist'
    
87. 
    
88.     def opj(self, *args):
    
89.         path = os.path.join(*args)
    
90.         return os.path.normpath(path)
    
91. 
    
92.     def find_data_files(self, srcdir, *wildcards, **kw):
    
93.         # 从源文件夹内获取文件
    
94.         def walk_helper(arg, dirname, files):
    
95.             # 当然你使用其他的版本控制工具什么的，也可以加进来
    
96.             if '.svn' in dirname:
    
97.                 return
    
98.             names = []
    
99.             lst, wildcards = arg
    
100.             for wc in wildcards:
     
101.                 wc_name = self.opj(dirname, wc)
     
102.                 for f in files:
     
103.                     filename = self.opj(dirname, f)
     
104. 
     
105.                     if fnmatch.fnmatch(filename, wc_name) and not os.path.isdir(filename):
     
106.                         names.append(filename)
     
107.             if names:
     
108.                 lst.append( (dirname, names ) )
     
109. 
     
110.         file_list = []
     
111.         recursive = kw.get('recursive', True)
     
112.         if recursive:
     
113.             os.path.walk(srcdir, walk_helper, (file_list, wildcards))
     
114.         else:
     
115.             walk_helper((file_list, wildcards),
     
116.                         srcdir,
     
117.                         [os.path.basename(f) for f in glob.glob(self.opj(srcdir, '*'))])
     
118.         return file_list
     
119. 
     
120.     def run(self):
     
121.         if os.path.isdir(self.dist_dir): # 删除上次的生成结果
     
122.             shutil.rmtree(self.dist_dir)
     
123. 
     
124.         # 获得默认图标
     
125.         if self.icon_file == None:
     
126.             path = os.path.split(pygame.__file__)[0]
     
127.             self.icon_file = os.path.join(path, 'pygame.ico')
     
128. 
     
129.         # 获得需要打包的数据文件
     
130.         extra_datas = []
     
131.         for data in self.extra_datas:
     
132.             if os.path.isdir(data):
     
133.                 extra_datas.extend(self.find_data_files(data, '*'))
     
134.             else:
     
135.                 extra_datas.append(('.', [data]))
     
136. 
     
137.         # 开始打包exe
     
138.         setup(
     
139.             cmdclass = {'py2exe': pygame2exe},
     
140.             version = self.project_version,
     
141.             description = self.project_description,
     
142.             name = self.project_name,
     
143.             url = self.project_url,
     
144.             author = self.author_name,
     
145.             author_email = self.author_email,
     
146.             license = self.license,
     
147. 
     
148.             # 默认生成窗口程序，如果需要生成终端程序(debug阶段)，使用：
     
149.             # console = [{
     
150.             windows = [{
     
151.                 'script': self.script,
     
152.                 'icon_resources': [(0, self.icon_file)],
     
153.                 'copyright': self.copyright
     
154.             }],
     
155.             options = {'py2exe': {'optimize': 2, 'bundle_files': 1,
     
156.                                   'compressed': True,
     
157.                                   'excludes': self.exclude_modules,
     
158.                                   'packages': self.extra_modules,
     
159.                                   'dist_dir': self.dist_dir,
     
160.                                   'dll_excludes': self.exclude_dll,
     
161.                                   'includes': self.extra_scripts} },
     
162.             zipfile = self.zipfile_name,
     
163.             data_files = extra_datas,
     
164.             )
     
165. 
     
166.         if os.path.isdir('build'): # 清除build文件夹
     
167.             shutil.rmtree('build')
     
168. 
     
169. if __name__ == '__main__':
     
170.     if len(sys.argv) < 2:
     
171.         sys.argv.append('py2exe')
     
172.     BuildExe().run()
     
173.     raw_input("Finished! Press any key to exit.")

复制代码

可以先从简单的程序开始，有了一点经验再尝试打包复杂的游戏。

一些Tips：

• 如果执行出错，会生成一个xxx.exe.log，参考这里的log信息看是不是少打包了东西。
• 一开始可以使用console来打包，这样可以在命令行里看到更多的信息。
• 对于每一个游戏，基本都需要拷贝上面的原始代码修改为独一无二的打包执行文件。
• 即使一个很小的py文件，最终生成的exe文件也很大（看安装的库而定，我这里最小4.7M左右），事实上py2exe在打包的时候会把无数的不需要的库都打进来导致最终文件臃肿，如果你安装了很繁杂的库(wxPython等）更是如此。使用zip打包以后查看里面的库文件，把不需要的逐一加入到self.exclude_modules中，最后可以把文件尺寸控制在一个可以接受的范围内。
  

2011/08/21 追记：
很多人在打包使用Font模块时出现问题，这里需要把sdl_ttf.dll声明为非系统文件，我已经修改了脚本默认就加入了。而且建议，如果将来是确定要打包为exe的，那么就不要使用系统字体，即”pygame.font.SysFont(xxx)”，而是使用字体文件，然后打包时将文件当作图片等一起打包，这样出问题的概率会大大降低。

2011/09/24 追记：
感谢blues_city网友，“dist_dir”应该是属于py2exe的特有options而不是setup的。

欢迎大家试用并提出建议，不断完善这个脚本。