From fa9f71be4ff767b5b1b0e7381092d6229eb33778 Mon Sep 17 00:00:00 2001 From: HojouFotytu <36724681+HojouFotytu@users.noreply.github.com> Date: Tue, 2 Feb 2021 12:25:02 +0900 Subject: [PATCH] update notes template --- .../settings.analyzer.json | 155 ++++++++---------- .../DevSettings/settings.analyzer.json | 98 +++++------ _Development/Update Notes Template.txt | 28 +++- 3 files changed, 133 insertions(+), 148 deletions(-) diff --git a/PTMagic/_defaults/_default settings PT 2.x/settings.analyzer.json b/PTMagic/_defaults/_default settings PT 2.x/settings.analyzer.json index 2b54862..db5f9c9 100644 --- a/PTMagic/_defaults/_default settings PT 2.x/settings.analyzer.json +++ b/PTMagic/_defaults/_default settings PT 2.x/settings.analyzer.json @@ -1,8 +1,7 @@ // -// The settings below offer a simple example of some of the options available when using PTMagic. +// The settings below offer a basic example of some of the options available when using PTMagic. // You should take your time and adjust these settings according to your own personal preferences. -// -// ALWAYS test your PTMagic settings by running a Profit Trailer bot in TESTMODE, to make sure +// Always test your PTMagic settings by running a Profit Trailer bot in TESTMODE, to make sure // it is performing as you expect. // // For more information on these settings, see the wiki at: https://github.com/PTMagicians/PTMagic/wiki/settings.analyzer @@ -16,33 +15,16 @@ "ExcludeMainCurrency": true, // Excludes the main currency (for example BTC) from market trend analysis "MarketTrends": [ { - "Name": "15m", // UNIQUE market trend name (to be referenced by your triggers below) + "Name": "1h", // UNIQUE market trend name (to be referenced by your triggers below) "Platform": "Exchange", // Platform to grab prices from (Allowed values are: CoinMarketCap, Exchange) "MaxMarkets": 50, // Number of markets/pairs to analyze sorted by 24h volume - "TrendMinutes": 15, // Number of minutes to build a trend (1440 = 24h, 720 = 12h, 60 = 1h) + "TrendMinutes": 60, // Number of minutes to build a trend (1440 = 24h, 720 = 12h, 60 = 1h) "TrendCurrency": "Market", // Trend Currency to build the trend against. If set to "Fiat", the trend will - // take the USD value of your main currency into account to build the trend. - // (Allowed values are: Fiat, Market) - "DisplayGraph": false, // Use this trend in the graph on the PTM Monitor dashboard and market analyzer - "DisplayOnMarketAnalyzerList": false // Disply this trend for all coins on the PTM Monitor market analyzer - }, - { - "Name": "1h", - "Platform": "Exchange", - "MaxMarkets": 50, - "TrendMinutes": 60, - "TrendCurrency": "Market", - "DisplayGraph": false, - "DisplayOnMarketAnalyzerList": true - }, - { - "Name": "3h", - "Platform": "Exchange", - "MaxMarkets": 50, - "TrendMinutes": 180, - "TrendCurrency": "Market", - "DisplayGraph": true, - "DisplayOnMarketAnalyzerList": true + // take the USD value of your main currency into account to build the trend. + // "Market" will build a trend against your base currency, such as BTC or USDT. + "TrendThreshold": 15, // Any coin that is above 15% or below -15% for this timeframe will not be used when calculating the market average. + "DisplayGraph": false, // Use this trend in the graph on the PTM Monitor dashboard and market analyzer + "DisplayOnMarketAnalyzerList": false // Disply this trend for all coins on the PTM Monitor market analyzer }, { "Name": "6h", @@ -50,8 +32,9 @@ "MaxMarkets": 50, "TrendMinutes": 360, "TrendCurrency": "Market", - "DisplayGraph": true, - "DisplayOnMarketAnalyzerList": true + "TrendThreshold": 30, + "DisplayGraph": true, + "DisplayOnMarketAnalyzerList": true }, { "Name": "12h", @@ -59,8 +42,9 @@ "MaxMarkets": 50, "TrendMinutes": 720, "TrendCurrency": "Market", - "DisplayGraph": true, - "DisplayOnMarketAnalyzerList": true + "TrendThreshold": 50, + "DisplayGraph": true, + "DisplayOnMarketAnalyzerList": true }, { "Name": "24h", @@ -68,25 +52,18 @@ "MaxMarkets": 50, "TrendMinutes": 1440, "TrendCurrency": "Market", - "DisplayGraph": false, - "DisplayOnMarketAnalyzerList": true - }, - { - "Name": "3d", - "Platform": "Exchange", - "MaxMarkets": 50, - "TrendMinutes": 4320, - "TrendCurrency": "Market", - "DisplayGraph": false, - "DisplayOnMarketAnalyzerList": true + "TrendThreshold": 75, + "DisplayGraph": true, + "DisplayOnMarketAnalyzerList": true } ] }, // ================================ GLOBAL SETTINGS ================================ - // - "GlobalSettings": [ // Global settings for Profit Trailer properties // - // ----------------------------- + "GlobalSettings": [ // Global settings for Profit Trailer properties + // + // =================================================================================== + // ----------------------------- { "SettingName": "EndOfTheWorld", // ANY UNIQUE name of your setting "TriggerConnection": "AND", // Define if triggers will be connected by AND or OR @@ -105,25 +82,21 @@ } ], "PairsProperties": { // Properties for PAIRS.PROPERTIES - // Any valid setting from https://wiki.profittrailer.com/doku.php?id=pairs_config can be used here. - // You can use a specific value, or apply a discrete OFFSET or OFFSETPERCENT to the value in your default PAIRS setting. - "DEFAULT_sell_only_mode_enabled": true, - "DEFAULT_trailing_profit_OFFSETPERCENT": -50 + // Any valid setting from https://wiki.profittrailer.com/en/config can be used here. + // You can use a specific value, or apply a discrete OFFSET or OFFSETPERCENT to the value in your default PAIRS setting. + "DEFAULT_sell_only_mode_enabled": true, + "DEFAULT_trailing_profit_OFFSETPERCENT": -50 }, "DCAProperties": { // Properties for DCA.PROPERTIES - "DEFAULT_DCA_trailing_profit_OFFSETPERCENT": -75 + "DEFAULT_DCA_trailing_profit_OFFSETPERCENT": -75 } }, - // ----------------------------- + // ----------------------------- { "SettingName": "TankingDown", "TriggerConnection": "AND", "Triggers": [ - { - "MarketTrendName": "15m", - "MaxChange": 0 - }, - { + { "MarketTrendName": "1h", "MaxChange": 0 }, @@ -139,21 +112,21 @@ ], "PairsProperties": { "max_trading_pairs_OFFSET": -2, - "DEFAULT_min_buy_volume_OFFSETPERCENT": 100, - //"DEFAULT_initial_cost_OFFSETPERCENT": -50, - //"DEFAULT_initial_cost_percentage_OFFSETPERCENT": -50, + "DEFAULT_min_buy_volume_OFFSETPERCENT": 100, + //"DEFAULT_initial_cost_OFFSETPERCENT": -50, + //"DEFAULT_initial_cost_percentage_OFFSETPERCENT": -50, "DEFAULT_trailing_buy_OFFSETPERCENT": 25, "DEFAULT_trailing_profit_OFFSETPERCENT": -25 }, "DCAProperties": { //"DEFAULT_DCA_rebuy_timeout_OFFSETPERCENT": 100, "DEFAULT_DCA_trailing_buy_OFFSETPERCENT": 25, - "DEFAULT_DCA_trailing_profit_OFFSETPERCENT": -50 + "DEFAULT_DCA_trailing_profit_OFFSETPERCENT": -50 }, - "IndicatorsProperties": { + "IndicatorsProperties": { } }, - // ----------------------------- + // ----------------------------- { "SettingName": "BearSighted", "TriggerConnection": "AND", @@ -174,19 +147,19 @@ ], "PairsProperties": { "max_trading_pairs_OFFSET": -1, - //"DEFAULT_initial_cost_OFFSETPERCENT": -25, - //"DEFAULT_initial_cost_percentage_OFFSETPERCENT": -25, + //"DEFAULT_initial_cost_OFFSETPERCENT": -25, + //"DEFAULT_initial_cost_percentage_OFFSETPERCENT": -25, "DEFAULT_trailing_buy_OFFSETPERCENT": 10, "DEFAULT_trailing_profit_OFFSETPERCENT": -10 }, "DCAProperties": { "DEFAULT_DCA_trailing_buy_OFFSETPERCENT": 10, - "DEFAULT_DCA_trailing_profit_OFFSETPERCENT": -10, + "DEFAULT_DCA_trailing_profit_OFFSETPERCENT": -10, }, - "IndicatorsProperties": { + "IndicatorsProperties": { } }, - // ----------------------------- + // ----------------------------- { "SettingName": "ReadyForLiftOff", "TriggerConnection": "AND", @@ -207,19 +180,19 @@ ], "PairsProperties": { "max_trading_pairs_OFFSET": 1, - //"DEFAULT_initial_cost_OFFSETPERCENT": 10, - //"DEFAULT_initial_cost_percentage_OFFSETPERCENT": 10, - "DEFAULT_trailing_buy_OFFSETPERCENT": -10, + //"DEFAULT_initial_cost_OFFSETPERCENT": 10, + //"DEFAULT_initial_cost_percentage_OFFSETPERCENT": 10, + "DEFAULT_trailing_buy_OFFSETPERCENT": -10, "DEFAULT_A_sell_value_OFFSETPERCENT": 10 }, "DCAProperties": { "DEFAULT_DCA_trailing_buy_OFFSETPERCENT": -10, - "DEFAULT_DCA_trailing_profit_OFFSETPERCENT": 10, + "DEFAULT_DCA_trailing_profit_OFFSETPERCENT": 10, }, - "IndicatorsProperties": { + "IndicatorsProperties": { } }, - // ----------------------------- + // ----------------------------- { "SettingName": "ToTheMoon", "TriggerConnection": "AND", @@ -239,16 +212,16 @@ ], "PairsProperties": { "max_trading_pairs_OFFSET": 2, - //"DEFAULT_initial_cost_OFFSETPERCENT": 20, - //"DEFAULT_initial_cost_percentage_OFFSETPERCENT": 20, + //"DEFAULT_initial_cost_OFFSETPERCENT": 20, + //"DEFAULT_initial_cost_percentage_OFFSETPERCENT": 20, "DEFAULT_trailing_buy_OFFSETPERCENT": -10, "DEFAULT_A_sell_value_OFFSETPERCENT": 20 }, "DCAProperties": { "DEFAULT_DCA_trailing_buy_OFFSETPERCENT": -20, - "DEFAULT_DCA_trailing_profit_OFFSETPERCENT": 20, + "DEFAULT_DCA_trailing_profit_OFFSETPERCENT": 20, }, - "IndicatorsProperties": { + "IndicatorsProperties": { } }, // ----------------------------- @@ -268,9 +241,9 @@ // ================================ COIN-SPECIFIC SETTINGS ================================ // "SingleMarketSettings": [ // Single market/pair settings for Profit Trailer properties - // Any setting from https://wiki.profittrailer.com/doku.php?id=pairs_config - // marked as CS (coin-specific) can be used here. - // Only coins that meet the triggered conditions will have the settings applied. + // Any setting from https://wiki.profittrailer.com/doku.php?id=pairs.properties + // marked as CS (coin-specific) can be used here. + // Only coins that meet the triggered conditions will have the settings applied. { "SettingName": "BlacklistCoins", "StopProcessWhenTriggered": true, @@ -285,16 +258,16 @@ "DEFAULT_DCA_enabled": false } }, - // ----------------------------- + // ----------------------------- { "SettingName": "PumpNDumpProtection", "TriggerConnection": "OR", "Triggers": [ { "MarketTrendName": "1h", - "MarketTrendRelation": "Relative", // The relation of the single market trend. Relative = Single market - // trend compared relative to the market trend - // Absolute = Single market trend viewed on its own + "MarketTrendRelation": "Relative", // The relation of the single market trend. Relative = Single market + // trend compared relative to the market trend + // Absolute = Single market trend viewed on its own "MinChange": 8 }, { @@ -308,10 +281,10 @@ "MinChange": 12 } ], - "OffTriggers": [ - { + "OffTriggers": [ + { "HoursSinceTriggered": 3 // Any coin that triggers this setting, will remain under this setting - // for 3 hours even if the trends are no longer true. + // for 3 hours, since the last time it triggered. } ], "PairsProperties": { @@ -319,7 +292,7 @@ "DEFAULT_DCA_enabled": false } }, - // ----------------------------- + // ----------------------------- { "SettingName": "FreefallBlock", "TriggerConnection": "OR", @@ -330,12 +303,12 @@ "MaxChange": -5 } ], - "OffTriggers": [ - { + "OffTriggers": [ + { "HoursSinceTriggered": 1 } ], - "PairsProperties": { + "PairsProperties": { "DEFAULT_sell_only_mode_enabled": true, "DEFAULT_DCA_enabled": false } diff --git a/_Development/DevSettings/settings.analyzer.json b/_Development/DevSettings/settings.analyzer.json index db5f9c9..baf14ff 100644 --- a/_Development/DevSettings/settings.analyzer.json +++ b/_Development/DevSettings/settings.analyzer.json @@ -11,20 +11,20 @@ "AnalyzerSettings": { "MarketAnalyzer": { "StoreDataMaxHours": 48, // Number of hours to store market data - "IntervalMinutes": 2, // Interval in minutes for PTMagic to check market trends and triggers + "IntervalMinutes": 2, // Interval in minutes for PTMagic to check market trends and triggers "ExcludeMainCurrency": true, // Excludes the main currency (for example BTC) from market trend analysis "MarketTrends": [ { "Name": "1h", // UNIQUE market trend name (to be referenced by your triggers below) "Platform": "Exchange", // Platform to grab prices from (Allowed values are: CoinMarketCap, Exchange) - "MaxMarkets": 50, // Number of markets/pairs to analyze sorted by 24h volume + "MaxMarkets": 50, // Number of markets/pairs to analyze sorted by 24h volume "TrendMinutes": 60, // Number of minutes to build a trend (1440 = 24h, 720 = 12h, 60 = 1h) "TrendCurrency": "Market", // Trend Currency to build the trend against. If set to "Fiat", the trend will - // take the USD value of your main currency into account to build the trend. + // take the USD value of your main currency into account to build the trend. // "Market" will build a trend against your base currency, such as BTC or USDT. "TrendThreshold": 15, // Any coin that is above 15% or below -15% for this timeframe will not be used when calculating the market average. - "DisplayGraph": false, // Use this trend in the graph on the PTM Monitor dashboard and market analyzer - "DisplayOnMarketAnalyzerList": false // Disply this trend for all coins on the PTM Monitor market analyzer + "DisplayGraph": false, // Use this trend in the graph on the PTM Monitor dashboard and market analyzer + "DisplayOnMarketAnalyzerList": false // Disply this trend for all coins on the PTM Monitor market analyzer }, { "Name": "6h", @@ -33,8 +33,8 @@ "TrendMinutes": 360, "TrendCurrency": "Market", "TrendThreshold": 30, - "DisplayGraph": true, - "DisplayOnMarketAnalyzerList": true + "DisplayGraph": true, + "DisplayOnMarketAnalyzerList": true }, { "Name": "12h", @@ -43,8 +43,8 @@ "TrendMinutes": 720, "TrendCurrency": "Market", "TrendThreshold": 50, - "DisplayGraph": true, - "DisplayOnMarketAnalyzerList": true + "DisplayGraph": true, + "DisplayOnMarketAnalyzerList": true }, { "Name": "24h", @@ -53,17 +53,17 @@ "TrendMinutes": 1440, "TrendCurrency": "Market", "TrendThreshold": 75, - "DisplayGraph": true, - "DisplayOnMarketAnalyzerList": true + "DisplayGraph": true, + "DisplayOnMarketAnalyzerList": true } ] }, // ================================ GLOBAL SETTINGS ================================ // "GlobalSettings": [ // Global settings for Profit Trailer properties - // - // =================================================================================== - // ----------------------------- + // + // =================================================================================== + // ----------------------------- { "SettingName": "EndOfTheWorld", // ANY UNIQUE name of your setting "TriggerConnection": "AND", // Define if triggers will be connected by AND or OR @@ -91,7 +91,7 @@ "DEFAULT_DCA_trailing_profit_OFFSETPERCENT": -75 } }, - // ----------------------------- + // ----------------------------- { "SettingName": "TankingDown", "TriggerConnection": "AND", @@ -112,21 +112,21 @@ ], "PairsProperties": { "max_trading_pairs_OFFSET": -2, - "DEFAULT_min_buy_volume_OFFSETPERCENT": 100, - //"DEFAULT_initial_cost_OFFSETPERCENT": -50, - //"DEFAULT_initial_cost_percentage_OFFSETPERCENT": -50, + "DEFAULT_min_buy_volume_OFFSETPERCENT": 100, + //"DEFAULT_initial_cost_OFFSETPERCENT": -50, + //"DEFAULT_initial_cost_percentage_OFFSETPERCENT": -50, "DEFAULT_trailing_buy_OFFSETPERCENT": 25, "DEFAULT_trailing_profit_OFFSETPERCENT": -25 }, "DCAProperties": { //"DEFAULT_DCA_rebuy_timeout_OFFSETPERCENT": 100, "DEFAULT_DCA_trailing_buy_OFFSETPERCENT": 25, - "DEFAULT_DCA_trailing_profit_OFFSETPERCENT": -50 + "DEFAULT_DCA_trailing_profit_OFFSETPERCENT": -50 }, - "IndicatorsProperties": { + "IndicatorsProperties": { } }, - // ----------------------------- + // ----------------------------- { "SettingName": "BearSighted", "TriggerConnection": "AND", @@ -147,16 +147,16 @@ ], "PairsProperties": { "max_trading_pairs_OFFSET": -1, - //"DEFAULT_initial_cost_OFFSETPERCENT": -25, - //"DEFAULT_initial_cost_percentage_OFFSETPERCENT": -25, + //"DEFAULT_initial_cost_OFFSETPERCENT": -25, + //"DEFAULT_initial_cost_percentage_OFFSETPERCENT": -25, "DEFAULT_trailing_buy_OFFSETPERCENT": 10, "DEFAULT_trailing_profit_OFFSETPERCENT": -10 }, "DCAProperties": { "DEFAULT_DCA_trailing_buy_OFFSETPERCENT": 10, - "DEFAULT_DCA_trailing_profit_OFFSETPERCENT": -10, + "DEFAULT_DCA_trailing_profit_OFFSETPERCENT": -10, }, - "IndicatorsProperties": { + "IndicatorsProperties": { } }, // ----------------------------- @@ -180,19 +180,19 @@ ], "PairsProperties": { "max_trading_pairs_OFFSET": 1, - //"DEFAULT_initial_cost_OFFSETPERCENT": 10, - //"DEFAULT_initial_cost_percentage_OFFSETPERCENT": 10, - "DEFAULT_trailing_buy_OFFSETPERCENT": -10, + //"DEFAULT_initial_cost_OFFSETPERCENT": 10, + //"DEFAULT_initial_cost_percentage_OFFSETPERCENT": 10, + "DEFAULT_trailing_buy_OFFSETPERCENT": -10, "DEFAULT_A_sell_value_OFFSETPERCENT": 10 }, "DCAProperties": { "DEFAULT_DCA_trailing_buy_OFFSETPERCENT": -10, - "DEFAULT_DCA_trailing_profit_OFFSETPERCENT": 10, + "DEFAULT_DCA_trailing_profit_OFFSETPERCENT": 10, }, - "IndicatorsProperties": { + "IndicatorsProperties": { } }, - // ----------------------------- + // ----------------------------- { "SettingName": "ToTheMoon", "TriggerConnection": "AND", @@ -212,16 +212,16 @@ ], "PairsProperties": { "max_trading_pairs_OFFSET": 2, - //"DEFAULT_initial_cost_OFFSETPERCENT": 20, - //"DEFAULT_initial_cost_percentage_OFFSETPERCENT": 20, + //"DEFAULT_initial_cost_OFFSETPERCENT": 20, + //"DEFAULT_initial_cost_percentage_OFFSETPERCENT": 20, "DEFAULT_trailing_buy_OFFSETPERCENT": -10, "DEFAULT_A_sell_value_OFFSETPERCENT": 20 }, "DCAProperties": { "DEFAULT_DCA_trailing_buy_OFFSETPERCENT": -20, - "DEFAULT_DCA_trailing_profit_OFFSETPERCENT": 20, + "DEFAULT_DCA_trailing_profit_OFFSETPERCENT": 20, }, - "IndicatorsProperties": { + "IndicatorsProperties": { } }, // ----------------------------- @@ -241,9 +241,9 @@ // ================================ COIN-SPECIFIC SETTINGS ================================ // "SingleMarketSettings": [ // Single market/pair settings for Profit Trailer properties - // Any setting from https://wiki.profittrailer.com/doku.php?id=pairs.properties - // marked as CS (coin-specific) can be used here. - // Only coins that meet the triggered conditions will have the settings applied. + // Any setting from https://wiki.profittrailer.com/en/config + // marked as CS (coin-specific) can be used here. + // Only coins that meet the triggered conditions will have the settings applied. { "SettingName": "BlacklistCoins", "StopProcessWhenTriggered": true, @@ -258,7 +258,7 @@ "DEFAULT_DCA_enabled": false } }, - // ----------------------------- + // ----------------------------- { "SettingName": "PumpNDumpProtection", "TriggerConnection": "OR", @@ -266,8 +266,8 @@ { "MarketTrendName": "1h", "MarketTrendRelation": "Relative", // The relation of the single market trend. Relative = Single market - // trend compared relative to the market trend - // Absolute = Single market trend viewed on its own + // trend compared relative to the market trend + // Absolute = Single market trend viewed on its own "MinChange": 8 }, { @@ -281,10 +281,10 @@ "MinChange": 12 } ], - "OffTriggers": [ - { - "HoursSinceTriggered": 3 // Any coin that triggers this setting, will remain under this setting - // for 3 hours, since the last time it triggered. + "OffTriggers": [ + { + "HoursSinceTriggered": 3 // Any coin that triggers this setting, will remain under this setting + // for 3 hours, since the last time it triggered. } ], "PairsProperties": { @@ -292,7 +292,7 @@ "DEFAULT_DCA_enabled": false } }, - // ----------------------------- + // ----------------------------- { "SettingName": "FreefallBlock", "TriggerConnection": "OR", @@ -303,12 +303,12 @@ "MaxChange": -5 } ], - "OffTriggers": [ - { + "OffTriggers": [ + { "HoursSinceTriggered": 1 } ], - "PairsProperties": { + "PairsProperties": { "DEFAULT_sell_only_mode_enabled": true, "DEFAULT_DCA_enabled": false } diff --git a/_Development/Update Notes Template.txt b/_Development/Update Notes Template.txt index 65b65d0..6004880 100644 --- a/_Development/Update Notes Template.txt +++ b/_Development/Update Notes Template.txt @@ -1,16 +1,28 @@ +// Please follow the structure below for PTM update notes, both on github and as an included .txt file. +// Release titles should follow the format: PTM (ver) -- (main feature) +// Check release history for examples. +// +// File naming should be standardized for auto-updating: PTM_x.x.x.zip +// + + + +# > Overview **This release...** -# Update Instructions +# > Update Instructions ### General - Always follow [these update instructions](https://github.com/PTMagicians/PTMagic/wiki/Updating-PT-Magic) when updating to a new version of PT Magic. -- PTMagic 2.1 only works with Profit Trailer v2.2. +- This version of PT Magic only works with Profit Trailer v2.4.x and above ### .Net -- You must upgrade .Net runtime on your operating system to version 2.1.7 or higher at -https://dotnet.microsoft.com/download/thank-you/dotnet-runtime-2.1.7-windows-hosting-bundle-installer +- PTMagic requires .Net Core Runtime 3.1 on the host operating system (download: https://dotnet.microsoft.com/download) -### IMPORTANT - REQUIRED settings changes -- If you are updating from an earlier version of PTMagic, check any releases since your version, or the default settings included with this release, for new lines that must be added to your settings file. +### Settings +- **If you are updating from any version of PTMagic prior to 2.4.1,** check the default settings included with this release for any new lines that might need to be added to your settings.general.json file. + +# > Changes +- A new... + +- Fixed... -# Changes --