Login Logout Preferences
Jump to: navigation, search

Difference between revisions of "Pixelmon launcher"

(Minecraft settings)
(28 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__
+
<languages/>
[[File:PixelmonLauncher.png|300px|thumb|right]]
+
<translate>
The Pixelmon launcher is an optional alternative ''Minecraft'' launcher that can be used to install and run Pixelmon. Additional mods can be installed along with Pixelmon as well, either manually or through the use of custom modpacks known as "Pixpacks". It was primarily designed to simplify and legalize the distribution and installation of Pixelmon modpacks.
+
<!--T:1-->
 +
The Pixelmon launcher is an optional alternative ''Minecraft'' launcher that can be used to install and run [[Pixelmon]]. It is custom-made specifically for using Pixelmon with ''Minecraft'', and has several features to simplify the installation and configuration of Pixelmon and its [[sidemods]].
  
The Pixelmon launcher is currently only compatible with Windows systems. It will not function on Mac OS X or Linux.
+
<!--T:2-->
==Installation and Setup==
+
The launcher provides support for the installation of Pixelmon sidemods that complement Pixelmon. Additional mods other than Pixelmon sidemods can be installed manually or through the use of custom modpacks known as "[[Pixpacks]]"; several sample Pixpacks are available directly from the Pixelmon launcher. The Pixelmon launcher can also use "patches" to update Pixelmon when new Pixelmon versions are released; these patches are smaller downloads compared to downloading the entire Pixelmon jar file to update to a new version.
 +
 
 +
The Pixelmon launcher is currently only compatible with Windows systems. It will not function on macOS or Linux; on these operating systems, the regular ''Minecraft'' launcher can still be used to [[install]] and use Pixelmon.
 +
==Installation and Setup== <!--T:3-->
 +
__TOC__
 
#Download the Pixelmon launcher [http://pixelmonmod.com/downloads.php here].
 
#Download the Pixelmon launcher [http://pixelmonmod.com/downloads.php here].
 
#Once the download is completed, run the downloaded executable file to install the Pixelmon launcher.
 
#Once the download is completed, run the downloaded executable file to install the Pixelmon launcher.
Line 10: Line 15:
 
#When the installation finishes, the Pixelmon launcher will start automatically. A shortcut will be placed on the desktop for future use.
 
#When the installation finishes, the Pixelmon launcher will start automatically. A shortcut will be placed on the desktop for future use.
 
#Enter in your ''Minecraft'' account details to log into your account.
 
#Enter in your ''Minecraft'' account details to log into your account.
 +
#*To complete this step, you need to own a purchased copy of the computer version of ''Minecraft''. You cannot use the Pixelmon launcher if you use a cracked version of ''Minecraft'', or if you only own ''Minecraft'' Pocket Edition (including Windows 10 Edition) or console editions (Xbox, PlayStation, Wii U).
 
#If you are using the launcher to run a Pixpack, click [[Pixelmon launcher#Running a Pixpack|here]]. Otherwise, continue below.
 
#If you are using the launcher to run a Pixpack, click [[Pixelmon launcher#Running a Pixpack|here]]. Otherwise, continue below.
 
#Click the "Create New Profile" button in the green box. This will cause the profile editor interface to appear.
 
#Click the "Create New Profile" button in the green box. This will cause the profile editor interface to appear.
 
#Choose the desired Pixelmon and Forge versions
 
#Choose the desired Pixelmon and Forge versions
 
#Name the new profile if desired.
 
#Name the new profile if desired.
#If you want to use any additional mods alongside Pixelmon, click the "Add Official Side-Mods" button for Pixelmon [[sidemods]] and/or the "Browse for Mods" button for other mods on your system.
+
#If you want to use any additional mods alongside Pixelmon, click the "Add Official Sidemods" button for Pixelmon [[sidemods]] and/or the "Browse for Mods" button for other mods on your system.
 
#Save your profile once you are finished creating it.
 
#Save your profile once you are finished creating it.
 
#Click the download icon in the top-right area of the launcher to install ''Minecraft'', Pixelmon, and Forge into the Pixelmon launcher. This may take a few minutes.
 
#Click the download icon in the top-right area of the launcher to install ''Minecraft'', Pixelmon, and Forge into the Pixelmon launcher. This may take a few minutes.
Line 22: Line 28:
 
LauncherProfileEdit.png|Editing an existing profile
 
LauncherProfileEdit.png|Editing an existing profile
 
</gallery>
 
</gallery>
 +
===Troubleshooting===
 +
*If the Pixelmon launcher crashes during the installation process, see [[Crash Reading 101/Pixelmon launcher]] for possible solutions. If you cannot find a solution on that page, post a support ticket on the [http://www.pixelmonmod.com/tracker.php?p=4 Pixelmon forums].
 +
*If you are unable to launch ''Minecraft'' because you cannot allocate enough memory to Pixelmon, see [[Fixing memory issues#32-bit Java|Fixing memory issues]].
 
==Settings==
 
==Settings==
 
===Profile settings===
 
===Profile settings===
 +
[[File:LauncherProfileSettings.png|thumb|The profile settings window]]
 
These settings can be found in the profile editor screen.
 
These settings can be found in the profile editor screen.
 
*Use custom window size: This allows a window size (width and height) to be defined exactly; it is an alternative to dragging the lower-right corner to resize the window.
 
*Use custom window size: This allows a window size (width and height) to be defined exactly; it is an alternative to dragging the lower-right corner to resize the window.
Line 29: Line 39:
 
*Keep output dialog open after ''Minecraft'' exits: This specifies whether the ''Minecraft'' console will persist after ''Minecraft'' closes.
 
*Keep output dialog open after ''Minecraft'' exits: This specifies whether the ''Minecraft'' console will persist after ''Minecraft'' closes.
 
*Reinstall all libraries next install: This will force all files to be re-downloaded the next time the profile is used.
 
*Reinstall all libraries next install: This will force all files to be re-downloaded the next time the profile is used.
===''Minecraft'' settings===
+
 
 +
===''Minecraft'' settings=== <!--T:4-->
 +
[[File:LauncherMinecraftSettings.png|thumb|The ''Minecraft'' settings window]]
 
These settings can be found by selecting the gear button in the top-right corner of the main menu.
 
These settings can be found by selecting the gear button in the top-right corner of the main menu.
 
*Volume: The volume of the music playing in the Pixelmon launcher.
 
*Volume: The volume of the music playing in the Pixelmon launcher.
*Minimum memory: The initial amount of memory to allocate to ''Minecraft'' when starting the game.
 
 
*Maximum memory: The maximum amount of memory that can be allocated to ''Minecraft'' when it is running.
 
*Maximum memory: The maximum amount of memory that can be allocated to ''Minecraft'' when it is running.
 
*Select Java Install: This specifies which version of Java to use when running ''Minecraft''.
 
*Select Java Install: This specifies which version of Java to use when running ''Minecraft''.
 +
*Change Storage Location: Allows the location of Pixelmon launcher data storage files to be changed.
 
*Java arguments: The JVM arguments to use when running ''Minecraft''.
 
*Java arguments: The JVM arguments to use when running ''Minecraft''.
 
*Auto-updater: This feature will check if there is a Pixelmon launcher update periodically (can be configured or disabled) and automatically update the Pixelmon launcher if there is one.
 
*Auto-updater: This feature will check if there is a Pixelmon launcher update periodically (can be configured or disabled) and automatically update the Pixelmon launcher if there is one.
 
*Enable advanced features: This enables certain features that should only be used by players with knowledge of the subject matter, such as JVM arguments.
 
*Enable advanced features: This enables certain features that should only be used by players with knowledge of the subject matter, such as JVM arguments.
  
===Other settings===
+
===Other settings=== <!--T:5-->
 
*Language can be changed by clicking the flag button in the top-right corner of the launcher.
 
*Language can be changed by clicking the flag button in the top-right corner of the launcher.
==Pixpacks==
+
==Version history==
Pixpacks are packages that can be used to make profiles in Pixelmon launcher. Within them, it is possible to bundle:
+
[[Version history/Pixelmon launcher]]
*A specific Pixelmon version
+
</translate>
*Additional mods
 
*Config files (for both Pixelmon and the additional mods)
 
*Resource packs and shaders
 
*World saves
 
*Server IPs
 
*A custom Pixelmon database
 
If a mod contained in the Pixpack doesn't allow distribution through external means, it is possible to instead link players to the mod's own download page.
 
===Creating a Pixpack===
 
''Note: The Pixelmon working on the next version of the Pixpack, which will support more capabilities and has better ways for Pack owners to manage and update Pixpacks. Although an effort will be made to support both the new and old Pixpack format, the information below may change soon.''
 
 
 
*To begin making a new Pixpack, create an empty folder (location is irrelevant).
 
*Using a text editor such as Notepad, create a file named "setup.json" inside the new empty folder. This file is used to define several aspects of the Pixpack, including its name and the mods to be included inside it. An example setup.json file is shown below:
 
{
 
  "Name":"{{tt|Example Pack|The name of the Pixpack}}",
 
  "URL":"{{tt|http://www.pixelmonmod.com|The website of the modpack or server}}",
 
  "requirements":{
 
    "pixelmon":"{{tt|3.4.0|The Pixelmon version to use in the Pixpack}}",
 
    "forge":"Forge 10.13.2.1230",
 
    "forgeBundled":true,
 
    "forgeFile": "forge-1.7.10-10.13.2.1230-installer.jar",
 
    "{{tt|mods|Mods other than Pixelmon and Forge that will be included in the Pixpack}}":[
 
      {
 
        "name":"{{tt|OptiFine_1.7.10_HD_U_A4.jar|A mod that must be downloaded from its website to be used.}}",
 
        "bundled":false,
 
        "downloadURL":"http://optifine.net/downloads.php"
 
      },
 
      {
 
        "filename":"{{tt|[[Pixelmon Extras|pixelmonextras]]-universal-1.7.10-1.0.5.jar|A mod that is directly included in the Pixpack}}",
 
        "bundled":true
 
      }
 
    ]
 
  },
 
"{{tt|resourcePacks|Resource packs to be included in the Pixpack}}":[{
 
    "name":"[[Pixelmon Dark]] v0.6.zip",
 
    "activated":true
 
  }],
 
  "{{tt|servers|Servers that will automatically be accessible from the multiplayer screen}}":[
 
  {
 
    "IP":"128.0.0.1",
 
    "Name":"Example Server"
 
  }]
 
}
 
[[File:Pixpack.png|thumb|right|The contents of an example Pixpack]]
 
*Depending on what you want to include inside the Pixpack, place any of the following items inside the folder:
 
**Mods that are bundled with the Pixpack (including the Forge installer)
 
**In a "config" folder, modified config files for any included mods (including the Pixelmon [[config]])
 
**In a "customdatabase" folder, a modified Pixelmon database (Pixelmon.h2.db)
 
**In a "resourcepacks" folder, any resource packs bundled with the Pixpack
 
**In a "saves" folder, world saves that will be available when using the Pixpack
 
**In a "shaderpacks" folder, shaders to be used with the Pixpack
 
**A "banner.png" file, which changes the banner at the top of the Pixelmon launcher. The default banner image can be found [http://pixelmonmod.com/wiki/index.php?title=File:LauncherBanner.png here].
 
**A "style.xaml" file, a text file that defines the color schemes used by various parts of the Pixelmon launcher. The default style.xaml file is shown below:
 
<ResourceDictionary xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">
 
    <Color x:Key="MainColour">#00000000</Color>
 
    <Color x:Key="DarkerColour">#33000000</Color>
 
    <Color x:Key="DarkestColour">#55000000</Color>
 
    <Color x:Key="MenuBGColour">#FF29B6F6</Color>
 
    <Color x:Key="LoginBGColour">#FF8BC34A</Color>
 
    <Color x:Key="ProfileRegionBGColour">#FF8BC34A</Color>
 
    <Color x:Key="ProfileRegionBGDarkColour">#FF6F9C3B</Color>
 
    <Color x:Key="ProfileRegionBGDarkerColour">#FF4F782C</Color>
 
    <Color x:Key="MainFontColour">White</Color>
 
    <Color x:Key="AltFontColour">Black</Color>
 
    <Color x:Key="RadioButtonPressed">#FF8BC34A</Color>
 
    <Color x:Key="PopupBGColour">#FF26A69A</Color>
 
    <Color x:Key="PopupBGDarkColour">#FF00897B</Color>
 
    <Color x:Key="PlayButtonInnerColor">#FF8BC34A</Color>
 
    <Color x:Key="PlayButtonOuterColor">White</Color>
 
    <Color x:Key="DeleteButtonBGColour">#FFEF5350</Color>
 
    <Color x:Key="SaveButtonBGColour">#FF00695C</Color>
 
</ResourceDictionary>
 
*After adding the files you want in the pack, highlight all of the files and compress them into a compressed (zipped) folder.
 
*Rename the zipped folder to the name you want for your Pixpack. Add the ".pixpack" extension after the file name.
 
 
 
===Running a Pixpack===
 
[[File:PixpackInstall.png|thumb|right]]
 
#Select the .pixpack file from Windows Explorer/File Explorer and open it with the Pixelmon launcher.
 
#If the Pixpack requires you to download mods via the mods' websites, follow the links provided and download them. Drag and drop the required mod files into the launcher.
 
#Click the "Install Profile" button.
 
#Click the button with the download icon at the top-right area of the launcher and wait for installation to finish.
 
#Run the pack directly from the box.
 
#In subsequent sessions, press the play button at the top-right area of the launcher, where the download icon previously was.
 

Revision as of 17:36, 27 July 2017

Other languages:
English • ‎español

The Pixelmon launcher is an optional alternative Minecraft launcher that can be used to install and run Pixelmon. It is custom-made specifically for using Pixelmon with Minecraft, and has several features to simplify the installation and configuration of Pixelmon and its sidemods.

The launcher provides support for the installation of Pixelmon sidemods that complement Pixelmon. Additional mods other than Pixelmon sidemods can be installed manually or through the use of custom modpacks known as "Pixpacks"; several sample Pixpacks are available directly from the Pixelmon launcher. The Pixelmon launcher can also use "patches" to update Pixelmon when new Pixelmon versions are released; these patches are smaller downloads compared to downloading the entire Pixelmon jar file to update to a new version.

The Pixelmon launcher is currently only compatible with Windows systems. It will not function on macOS or Linux; on these operating systems, the regular Minecraft launcher can still be used to install and use Pixelmon.

Installation and Setup

  1. Download the Pixelmon launcher here.
  2. Once the download is completed, run the downloaded executable file to install the Pixelmon launcher.
  3. Accept the terms and conditions and specify where the Pixelmon launcher should be installed.
  4. When the installation finishes, the Pixelmon launcher will start automatically. A shortcut will be placed on the desktop for future use.
  5. Enter in your Minecraft account details to log into your account.
    • To complete this step, you need to own a purchased copy of the computer version of Minecraft. You cannot use the Pixelmon launcher if you use a cracked version of Minecraft, or if you only own Minecraft Pocket Edition (including Windows 10 Edition) or console editions (Xbox, PlayStation, Wii U).
  6. If you are using the launcher to run a Pixpack, click here. Otherwise, continue below.
  7. Click the "Create New Profile" button in the green box. This will cause the profile editor interface to appear.
  8. Choose the desired Pixelmon and Forge versions
  9. Name the new profile if desired.
  10. If you want to use any additional mods alongside Pixelmon, click the "Add Official Sidemods" button for Pixelmon sidemods and/or the "Browse for Mods" button for other mods on your system.
  11. Save your profile once you are finished creating it.
  12. Click the download icon in the top-right area of the launcher to install Minecraft, Pixelmon, and Forge into the Pixelmon launcher. This may take a few minutes.
  13. Once the downloading is finished, the download icon will be replaced with a play icon. Pressing this button will launch Minecraft.

Troubleshooting

Settings

Profile settings

The profile settings window

These settings can be found in the profile editor screen.

  • Use custom window size: This allows a window size (width and height) to be defined exactly; it is an alternative to dragging the lower-right corner to resize the window.
  • Additional arguments to use when initializing Minecraft.
  • Keep output dialog open after Minecraft exits: This specifies whether the Minecraft console will persist after Minecraft closes.
  • Reinstall all libraries next install: This will force all files to be re-downloaded the next time the profile is used.

Minecraft settings

The Minecraft settings window

These settings can be found by selecting the gear button in the top-right corner of the main menu.

  • Volume: The volume of the music playing in the Pixelmon launcher.
  • Maximum memory: The maximum amount of memory that can be allocated to Minecraft when it is running.
  • Select Java Install: This specifies which version of Java to use when running Minecraft.
  • Change Storage Location: Allows the location of Pixelmon launcher data storage files to be changed.
  • Java arguments: The JVM arguments to use when running Minecraft.
  • Auto-updater: This feature will check if there is a Pixelmon launcher update periodically (can be configured or disabled) and automatically update the Pixelmon launcher if there is one.
  • Enable advanced features: This enables certain features that should only be used by players with knowledge of the subject matter, such as JVM arguments.

Other settings

  • Language can be changed by clicking the flag button in the top-right corner of the launcher.

Version history

Version history/Pixelmon launcher